python-package-template-pypi 0.0.3__tar.gz → 0.1.0__tar.gz

python_package_template_pypi-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,15 @@
+---
+name: CI
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+
+jobs:
+  tox:
+    uses: daniel-mizsak/workflows/.github/workflows/tox.yml@main
+    with:
+      python-version: "['3.11', '3.12']"
+      codecov: true
+    secrets: inherit

python_package_template_pypi-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,22 @@
+---
+name: release
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  release:
+    uses: daniel-mizsak/workflows/.github/workflows/pypi.yml@main
+    with:
+      environment: pypi
+      python-version: "3.12"
+    secrets: inherit
+
+  gh-pages:
+    permissions:
+      contents: write
+
+    uses: daniel-mizsak/workflows/.github/workflows/gh-pages.yml@main
+    with:
+      python-version: "3.12"

{python_package_template_pypi-0.0.3 → python_package_template_pypi-0.1.0}/.gitignore

@@ -22,6 +22,7 @@ wheels/
 # Unit test / Coverage reports
 .coverage
 .tox
+coverage.xml
 htmlcov/
 
 # Jupyter Notebook

{python_package_template_pypi-0.0.3 → python_package_template_pypi-0.1.0}/.pre-commit-config.yaml

@@ -21,7 +21,7 @@ repos:
 
   # ruff
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.5
+    rev: v0.4.1
     hooks:
       # Ruff linting
       - id: ruff

{python_package_template_pypi-0.0.3 → python_package_template_pypi-0.1.0}/PKG-INFO

@@ -1,8 +1,11 @@
 Metadata-Version: 2.3
 Name: python-package-template-pypi
-Version: 0.0.3
+Version: 0.1.0
 Summary: A github template with my python package configurations.
+Project-URL: Homepage, https://pythonvilag.hu/
+Project-URL: Documentation, https://python-package-template-pypi.readthedocs.io/en/latest/
 Project-URL: Repository, https://github.com/daniel-mizsak/python-package-template
+Project-URL: Issues, https://github.com/daniel-mizsak/python-package-template/issues
 Author-email: Daniel Mizsak <info@pythonvilag.hu>
 License: MIT License
         
@@ -26,10 +29,12 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
 License-File: LICENSE
+Keywords: github,package,pypi,python,template
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.12
+Requires-Python: >=3.11
 Provides-Extra: dev
 Requires-Dist: hatch; extra == 'dev'
 Requires-Dist: mypy; extra == 'dev'
@@ -77,7 +82,7 @@ For documentation:
 Codecov is used to check the code coverage of the tests.\
 It also provides a badge that can be added to the README file.
 
-The way it is set up can be seen in the `.github/workflows/ci.yml` file, but it will probably be moved to my reusable [GitHub Workflows repository](https://github.com/daniel-mizsak/workflows).
+Codecov is set up to be part of the [tox reusable workflow](https://github.com/daniel-mizsak/workflows/blob/main/.github/workflows/tox.yml), but for this action it is important to generate the coverage report using the `--cov-report=xml` flag in the `pyproject.toml` file.
 
 ### Pre-Commit
 Pre-Commit is used to run certain checks on the code before it is committed.\

{python_package_template_pypi-0.0.3 → python_package_template_pypi-0.1.0}/README.md

@@ -31,7 +31,7 @@ For documentation:
 Codecov is used to check the code coverage of the tests.\
 It also provides a badge that can be added to the README file.
 
-The way it is set up can be seen in the `.github/workflows/ci.yml` file, but it will probably be moved to my reusable [GitHub Workflows repository](https://github.com/daniel-mizsak/workflows).
+Codecov is set up to be part of the [tox reusable workflow](https://github.com/daniel-mizsak/workflows/blob/main/.github/workflows/tox.yml), but for this action it is important to generate the coverage report using the `--cov-report=xml` flag in the `pyproject.toml` file.
 
 ### Pre-Commit
 Pre-Commit is used to run certain checks on the code before it is committed.\

{python_package_template_pypi-0.0.3 → python_package_template_pypi-0.1.0}/hatch.toml

@@ -3,7 +3,7 @@ dependencies = ["pytest", "pytest-cov"]
 [envs.default.scripts]
 run = "pytest"
 [[envs.default.matrix]]
-python = ["3.12"]
+python = ["3.11", "3.12"]
 
 [envs.ruff]
 dependencies = ["ruff"]

{python_package_template_pypi-0.0.3 → python_package_template_pypi-0.1.0}/pyproject.toml

@@ -6,24 +6,32 @@ build-backend = "hatchling.build"
 # Project Metadata
 [project]
 name = "python-package-template-pypi" # Name has to be unique on pypi.
-version = "0.0.3"
+version = "0.1.0"
 description = "A github template with my python package configurations."
 readme = "README.md"
-requires-python = ">=3.12"
+requires-python = ">=3.11"
 license = { file = "LICENSE" }
 authors = [{ name = "Daniel Mizsak", email = "info@pythonvilag.hu" }]
-keywords = []
+keywords = ["python", "template", "package", "github", "pypi"]
 classifiers = [
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
 ]
 dependencies = []
 [project.optional-dependencies]
 dev = ["hatch", "mypy", "pre-commit", "pytest-cov", "pytest", "ruff", "tox"]
 docs = ["furo", "sphinx", "sphinx-copybutton"]
+
+[project.scripts]
+ppt = "python_package_template.cli:main"
+
 [project.urls]
+Homepage = "https://pythonvilag.hu/"
+Documentation = "https://python-package-template-pypi.readthedocs.io/en/latest/"
 Repository = "https://github.com/daniel-mizsak/python-package-template"
+Issues = "https://github.com/daniel-mizsak/python-package-template/issues"
 
 # Tools
 # Hatch
@@ -42,5 +50,10 @@ warn_unused_ignores = true
 
 # Pytest
 [tool.pytest.ini_options]
-addopts = "--cov=python_package_template --cov=tests --cov-config=pyproject.toml --cov-report=term-missing --cov-report=html"
+addopts = "--cov=python_package_template --cov=tests --cov-config=pyproject.toml --cov-report=term-missing --cov-report=html --cov-report=xml"
 testpaths = ["tests"]
+
+# Coverage
+[tool.coverage.report]
+exclude_also = ["if TYPE_CHECKING:", "if __name__ == '__main__':"]
+omit = ["**/__main__.py"]

{python_package_template_pypi-0.0.3 → python_package_template_pypi-0.1.0}/src/python_package_template/__init__.py

@@ -6,7 +6,7 @@ Init file for the package.
 
 import importlib.metadata
 
-from python_package_template.main import add_five
+from python_package_template.main import add_five, subtract_three
 
-__all__ = ["add_five"]
+__all__ = ["add_five", "subtract_three"]
 __version__ = importlib.metadata.version("python-package-template-pypi")

python_package_template_pypi-0.1.0/src/python_package_template/__main__.py

@@ -0,0 +1,10 @@
+"""
+Main entry point of the package to run as script.
+
+@author "Daniel Mizsak" <info@pythonvilag.hu>
+"""
+
+from python_package_template.cli import main
+
+if __name__ == "__main__":
+    main()

python_package_template_pypi-0.1.0/src/python_package_template/cli.py

@@ -0,0 +1,23 @@
+"""
+Command line interface for the Python package template.
+
+@author "Daniel Mizsak" <info@pythonvilag.hu>
+"""
+
+import argparse
+
+from python_package_template.main import add_five, subtract_three
+
+
+def main() -> None:
+    """Main entry point for the CLI."""
+    parser = argparse.ArgumentParser(description="Run the PPT CLI.")
+
+    parser.add_argument("number", type=int, help="The number to run the operations on.")
+    args = parser.parse_args()
+
+    plus_five = add_five(args.number)
+    print(f"Adding 5 to {args.number} gives {plus_five}.")  # noqa: T201
+
+    minus_three = subtract_three(args.number)
+    print(f"Subtracting 3 from {args.number} gives {minus_three}.")  # noqa: T201

{python_package_template_pypi-0.0.3 → python_package_template_pypi-0.1.0}/src/python_package_template/main.py

@@ -15,3 +15,15 @@ def add_five(x: int) -> int:
         int: The input incremented by 5.
     """
     return x + 5
+
+
+def subtract_three(x: int) -> int:
+    """Decrement the input by 3.
+
+    Args:
+        x (int): The input number.
+
+    Returns:
+        int: The input decremented by 3.
+    """
+    return x - 3

python_package_template_pypi-0.1.0/tests/cli_test.py

@@ -0,0 +1,19 @@
+"""
+Tests for the CLI module.
+
+@author "Daniel Mizsak" <info@pythonvilag.hu>
+"""
+
+from typing import Any
+
+from python_package_template.cli import main
+
+
+def test_main(monkeypatch: Any, capsys: Any) -> None:  # noqa: ANN401
+    cli_arguments = ["", "7"]  # sys.argv[0] is the name of the script
+    monkeypatch.setattr("sys.argv", cli_arguments)
+    main()
+
+    captured = capsys.readouterr()
+    assert "Adding 5 to 7 gives 12." in captured.out
+    assert "Subtracting 3 from 7 gives 4." in captured.out

python_package_template_pypi-0.1.0/tests/conftest.py

@@ -0,0 +1,5 @@
+"""
+Provide fixtures for all the tests.
+
+@author "Daniel Mizsak" <info@pythonvilag.hu>
+"""

python_package_template_pypi-0.1.0/tests/main_test.py

@@ -0,0 +1,19 @@
+"""
+Tests for the main module.
+
+@author "Daniel Mizsak" <info@pythonvilag.hu>
+"""
+
+from python_package_template.main import add_five, subtract_three
+
+
+def test_add_five() -> None:
+    assert add_five(5) == 10
+    assert add_five(0) == 5
+    assert add_five(-5) == 0
+
+
+def test_subtract_three() -> None:
+    assert subtract_three(5) == 2
+    assert subtract_three(0) == -3
+    assert subtract_three(-5) == -8

{python_package_template_pypi-0.0.3 → python_package_template_pypi-0.1.0}/tox.ini

@@ -1,5 +1,6 @@
 [tox]
 envlist =
+    py311
     py312
     ruff
     mypy
@@ -8,6 +9,7 @@ skip_missing_interpreters = true
 
 [gh]
 python =
+    3.11 = py311
     3.12 = py312, ruff, mypy, docs
 
 [testenv]
@@ -27,8 +29,7 @@ commands =
 deps =
     mypy
 commands =
-    mypy src
-    mypy tests
+    mypy src tests
 
 [testenv:docs]
 extras =

python_package_template_pypi-0.0.3/.github/workflows/ci.yml

@@ -1,42 +0,0 @@
----
-name: CI
-on:
-  pull_request:
-    branches:
-      - main
-  push:
-
-jobs:
-  tox:
-    uses: daniel-mizsak/workflows/.github/workflows/tox.yml@main
-    with:
-      python-version: "3.12"
-
-  codecov:
-    needs: tox
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out the codebase.
-        uses: actions/checkout@v4
-
-      - name: Set up python.
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-
-      - name: Upgrade pip.
-        run: >
-          python -m pip install --upgrade pip
-
-      - name: Install package locally.
-        run: >
-          pip install .[dev]
-
-      - name: Generate coverage report.
-        run: >
-          pytest
-
-      - name: Run codecov.
-        uses: codecov/codecov-action@v4.0.1
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}

python_package_template_pypi-0.0.3/.github/workflows/release.yml

@@ -1,47 +0,0 @@
----
-name: release
-on:
-  push:
-    tags:
-      - "*"
-
-jobs:
-  release:
-    runs-on: ubuntu-latest
-    environment:
-      name: pypi
-      url: https://pypi.org/project/python-package-template-pypi
-    permissions:
-      id-token: write
-
-    steps:
-      - name: Check out the codebase.
-        uses: actions/checkout@v4
-
-      - name: Set up python.
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-
-      - name: Upgrade pip.
-        run: >
-          python -m pip install --upgrade pip
-
-      - name: Install dependencies.
-        run: >
-          pip install build
-
-      - name: Build the package.
-        run: >
-          python -m build
-
-      - name: Publish the package.
-        uses: pypa/gh-action-pypi-publish@release/v1
-
-  gh-pages:
-    permissions:
-      contents: write
-
-    uses: daniel-mizsak/workflows/.github/workflows/gh-pages.yml@main
-    with:
-      python-version: "3.12"

python_package_template_pypi-0.0.3/tests/main_test.py

@@ -1,13 +0,0 @@
-"""
-Tests for the main module.
-
-@author "Daniel Mizsak" <info@pythonvilag.hu>
-"""
-
-from python_package_template.main import add_five
-
-
-def test_add_five() -> None:
-    assert add_five(5) == 10
-    assert add_five(0) == 5
-    assert add_five(-5) == 0