Skip to content

Commit

Permalink
#5 Restructure project for PyPi (#6)
Browse files Browse the repository at this point in the history
* #5 Restructure project for PyPi

* #5 Fix build error
  • Loading branch information
conorheffron authored Oct 12, 2024
1 parent cfc7d92 commit 7c92904
Show file tree
Hide file tree
Showing 8 changed files with 63 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@

/__pycache__
/pytest-env
/src/ironoc_pytest_conorheffron/__pycache__
/tests/__pycache__
19 changes: 19 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright (c) 2016 The Python Packaging Authority (PyPA)

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
37 changes: 37 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

[project]
name = "ironoc_pytest_conor_heffron"
version = "1.6.0"
authors = [
{ name="Conor Heffron", email="conor.heffron@gmail.com" },
]
description = "A pytest example package"
readme = "README.md"
requires-python = ">=3.11"
license = {file = "LICENSE.txt"}
classifiers = [
# How mature is this project? Common values are
# 3 - Alpha
# 4 - Beta
# 5 - Production/Stable
"Development Status :: 3 - Alpha",

# Indicate who your project is intended for
"Intended Audience :: Developers",
"Topic :: Software Development :: Build Tools",

# Pick your license as you wish
"License :: OSI Approved :: MIT License",

# Specify the Python versions you support here. In particular, ensure
# that you indicate you support Python 3. These classifiers are *not*
# checked by "pip install". See instead "requires-python" key in this file.
"Programming Language :: Python :: 3.11",
]

[project.urls]
Homepage = "https://github.com/conorheffron/ironoc-pytest"
Issues = "https://github.com/conorheffron/ironoc-pytest/issues"
3 changes: 3 additions & 0 deletions src/ironoc_pytest_conorheffron/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
def main():
"""Entry point for the application script"""
print("Call your main application code here")
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import json
from github_model import GithubModel
from .github_model import GithubModel
import pandas as pd
import requests

Expand Down
File renamed without changes.
Empty file added tests/__init__.py
Empty file.
2 changes: 1 addition & 1 deletion test_github_api.py → tests/test_github_api.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import json
from github_api import GitHubClient
from src.ironoc_pytest_conorheffron.github_api import GitHubClient

def test_github_api_conorheffron_success():
# given
Expand Down

0 comments on commit 7c92904

Please sign in to comment.