python-package-template-pypi 0.0.4__tar.gz → 0.1.1__tar.gz

python_package_template_pypi-0.1.1/.devcontainer/devcontainer.json

@@ -0,0 +1,25 @@
+{
+  "name": "Python 3.12 Development Environment",
+  "image": "python:3.12",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "njpwerner.autodocstring",
+        "aaron-bond.better-comments",
+        "streetsidesoftware.code-spell-checker",
+        "tamasfe.even-better-toml",
+        "GitHub.copilot",
+        "eamodio.gitlens",
+        "oderwat.indent-rainbow",
+        "ms-python.mypy-type-checker",
+        "ms-python.python",
+        "charliermarsh.ruff"
+      ]
+    }
+  },
+  "postCreateCommand": "pip install -e '.[dev]'",
+  "runArgs": [
+    "--name",
+    "${localEnv:USER}_python_devcontainer"
+  ]
+}

{python_package_template_pypi-0.0.4 → python_package_template_pypi-0.1.1}/.github/workflows/ci.yml

@@ -10,6 +10,6 @@ jobs:
   tox:
     uses: daniel-mizsak/workflows/.github/workflows/tox.yml@main
     with:
-      python-version: "['3.11', '3.12']"
+      python-versions: "['3.11', '3.12']"
       codecov: true
     secrets: inherit

python_package_template_pypi-0.1.1/.github/workflows/stale.yml

@@ -0,0 +1,24 @@
+---
+name: stale
+on:
+  schedule:
+    - cron: "30 1 * * 1"
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+
+    steps:
+      - uses: actions/stale@v9
+        with:
+          stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
+          stale-pr-message: 'This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.'
+          close-issue-message: 'This issue was closed because it has been stalled for 5 days with no activity.'
+          close-pr-message: 'This PR was closed because it has been stalled for 10 days with no activity.'
+          days-before-issue-stale: 30
+          days-before-pr-stale: 45
+          days-before-issue-close: 5
+          days-before-pr-close: 10

{python_package_template_pypi-0.0.4 → python_package_template_pypi-0.1.1}/.pre-commit-config.yaml

@@ -3,6 +3,10 @@
 
 # exclude: ""
 
+# pre-commit ci
+ci:
+  autoupdate_schedule: monthly
+
 # pre-commit
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -19,9 +23,15 @@ repos:
       - id: name-tests-test
       - id: trailing-whitespace
 
+  # gitleaks
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.18.4
+    hooks:
+      - id: gitleaks
+
   # ruff
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.7
+    rev: v0.5.6
     hooks:
       # Ruff linting
       - id: ruff

{python_package_template_pypi-0.0.4 → python_package_template_pypi-0.1.1}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Daniel Mizsak
+Copyright (c) 2024 Daniel Mizsak
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{python_package_template_pypi-0.0.4 → python_package_template_pypi-0.1.1}/PKG-INFO

@@ -1,12 +1,15 @@
 Metadata-Version: 2.3
 Name: python-package-template-pypi
-Version: 0.0.4
+Version: 0.1.1
 Summary: A github template with my python package configurations.
+Project-URL: Documentation, https://python-package-template-pypi.readthedocs.io/en/latest/
+Project-URL: Homepage, https://pythonvilag.hu/
+Project-URL: Issues, https://github.com/daniel-mizsak/python-package-template/issues
 Project-URL: Repository, https://github.com/daniel-mizsak/python-package-template
 Author-email: Daniel Mizsak <info@pythonvilag.hu>
 License: MIT License
         
-        Copyright (c) Daniel Mizsak
+        Copyright (c) 2024 Daniel Mizsak
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
@@ -26,6 +29,7 @@ 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

{python_package_template_pypi-0.0.4 → python_package_template_pypi-0.1.1}/docs/add_five.rst

@@ -16,4 +16,4 @@ To increment the value of a number by five, use the `add_five` function.
 Description of the `add_five` function:
 ---------------------------------------
 
-.. autofunction:: python_package_template.main.add_five
+.. autofunction:: python_package_template.add_five

{python_package_template_pypi-0.0.4 → python_package_template_pypi-0.1.1}/docs/index.rst

@@ -7,3 +7,4 @@ This is a template repository for my python packages.
    :hidden:
 
    add_five
+   subtract_three

python_package_template_pypi-0.1.1/docs/subtract_three.rst

@@ -0,0 +1,19 @@
+Subtract three
+==============
+
+Example call
+------------
+
+To decrement the value of a number by three, use the `subtract_three` function.
+
+.. code-block:: python
+
+    from python_package_template import subtract_three
+
+    print(subtract_three(8))
+
+
+Description of the `subtract_three` function:
+---------------------------------------------
+
+.. autofunction:: python_package_template.subtract_three

python_package_template_pypi-0.1.1/pyproject.toml

@@ -0,0 +1,59 @@
+# Build System
+[build-system]
+  requires = ["hatchling"]
+  build-backend = "hatchling.build"
+
+# Project Metadata
+[project]
+  name = "python-package-template-pypi" # Name has to be unique on pypi.
+  version = "0.1.1"
+  description = "A github template with my python package configurations."
+  readme = "README.md"
+  requires-python = ">=3.11"
+  license = { file = "LICENSE" }
+  authors = [{ name = "Daniel Mizsak", email = "info@pythonvilag.hu" }]
+  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]
+    Documentation = "https://python-package-template-pypi.readthedocs.io/en/latest/"
+    Homepage = "https://pythonvilag.hu/"
+    Issues = "https://github.com/daniel-mizsak/python-package-template/issues"
+    Repository = "https://github.com/daniel-mizsak/python-package-template"
+
+# Tools
+# Hatch
+[tool.hatch.build.targets.wheel]
+  packages = ["src/python_package_template"]
+
+# MyPy
+[tool.mypy]
+  ignore_missing_imports = true
+  pretty = true
+  show_column_numbers = true
+  show_error_context = true
+  strict = true
+  warn_unreachable = true
+  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 --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.4 → python_package_template_pypi-0.1.1}/ruff.toml

@@ -1,6 +1,7 @@
 # Exclude a variety of commonly ignored directories.
 # exclude = [""]
 
+src = ["src", "test"]
 line-length = 120
 indent-width = 4
 

{python_package_template_pypi-0.0.4 → python_package_template_pypi-0.1.1}/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.1/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.1/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.4 → python_package_template_pypi-0.1.1}/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.1/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.1/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.1/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.4 → python_package_template_pypi-0.1.1}/tox.ini

@@ -29,11 +29,11 @@ commands =
 deps =
     mypy
 commands =
-    mypy src
-    mypy tests
+    mypy src tests
 
 [testenv:docs]
 extras =
     docs
 commands =
-    sphinx-build -b html -d "{envtmpdir}{/}doctree" docs "{toxworkdir}{/}docs_out" --color
+    sphinx-build --builder html --doctree-dir "{envtmpdir}{/}doctree" \
+    docs "{toxworkdir}{/}docs_out" --color --fail-on-warning

python_package_template_pypi-0.0.4/.devcontainer/devcontainer.json

@@ -1,4 +0,0 @@
-{
-  "name": "Python Development Environment",
-  "image": "python:3.12"
-}

python_package_template_pypi-0.0.4/pyproject.toml

@@ -1,47 +0,0 @@
-# Build System
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
-# Project Metadata
-[project]
-name = "python-package-template-pypi" # Name has to be unique on pypi.
-version = "0.0.4"
-description = "A github template with my python package configurations."
-readme = "README.md"
-requires-python = ">=3.11"
-license = { file = "LICENSE" }
-authors = [{ name = "Daniel Mizsak", email = "info@pythonvilag.hu" }]
-keywords = []
-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.urls]
-Repository = "https://github.com/daniel-mizsak/python-package-template"
-
-# Tools
-# Hatch
-[tool.hatch.build.targets.wheel]
-packages = ["src/python_package_template"]
-
-# MyPy
-[tool.mypy]
-ignore_missing_imports = true
-pretty = true
-show_column_numbers = true
-show_error_context = true
-strict = true
-warn_unreachable = true
-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 --cov-report=xml"
-testpaths = ["tests"]

python_package_template_pypi-0.0.4/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