python-package-template-pypi 0.2.3__tar.gz → 0.3.0__tar.gz

{python_package_template_pypi-0.2.3 → python_package_template_pypi-0.3.0}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Daniel Mizsak
+Copyright (c) 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.3.0/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.3
+Name: python-package-template-pypi
+Version: 0.3.0
+Summary: Python package template configuration.
+Keywords: python,template,package,github,pypi
+Author: Daniel Mizsak
+Author-email: Daniel Mizsak <info@pythonvilag.hu>
+License: MIT License
+         
+         Copyright (c) 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
+         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.
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: numpy==2.4.1
+Requires-Python: >=3.12
+Project-URL: Documentation, https://daniel-mizsak.github.io/python-package-template/
+Project-URL: Issues, https://github.com/daniel-mizsak/python-package-template/issues/
+Project-URL: Repository, https://github.com/daniel-mizsak/python-package-template/
+Description-Content-Type: text/markdown
+
+# <div align="center">🐍 python-package-template</div>
+
+<div align="center">
+    <kbd>
+        <a href="https://github.com/daniel-mizsak/python-package-template/actions/workflows/ci.yml" target="_blank"><img src="https://github.com/daniel-mizsak/python-package-template/actions/workflows/ci.yml/badge.svg" alt="build status"></a>
+        <a href="https://codecov.io/gh/daniel-mizsak/python-package-template" target="_blank"><img src="https://codecov.io/gh/daniel-mizsak/python-package-template/graph/badge.svg?token=SDXG1S8PVM" alt="codecov"></a>
+        <a href="https://results.pre-commit.ci/latest/github/daniel-mizsak/python-package-template/main" target="_blank"><img src="https://results.pre-commit.ci/badge/github/daniel-mizsak/python-package-template/main.svg" alt="pre-commit.ci status"></a>
+        <a href="https://pypi.org/project/python-package-template-pypi" target="_blank"><img src="https://img.shields.io/pypi/v/python-package-template-pypi" alt="pypi version"></a>
+        <a href="https://img.shields.io/github/license/daniel-mizsak/python-package-template" target="_blank"><img src="https://img.shields.io/github/license/daniel-mizsak/python-package-template" alt="license"></a>
+    </kbd>
+</div>
+
+## Overview
+
+Python package template configuration.
+
+## Getting started
+
+> [!CAUTION]
+> This template represents my personal understanding of the current best practices.\
+> It is advised to do further research before implementing these configurations in your environment.
+
+Documentation is available at the [GitHub Pages of this repository](https://daniel-mizsak.github.io/python-package-template).
+
+<hr>
+
+<div align="center">
+    <strong>⭐ Star the repository if you found it useful ⭐</strong>
+    <br>
+    <a href="https://github.com/daniel-mizsak/repository-template" target="_blank">Repository Template</a> |
+    <a href="https://github.com/daniel-mizsak/workflows" target="_blank">Reusable Workflows</a> |
+    <a href="https://github.com/daniel-mizsak/mtjd" target="_blank">Development Environment </a>
+</div>

python_package_template_pypi-0.3.0/README.md

@@ -0,0 +1,33 @@
+# <div align="center">🐍 python-package-template</div>
+
+<div align="center">
+    <kbd>
+        <a href="https://github.com/daniel-mizsak/python-package-template/actions/workflows/ci.yml" target="_blank"><img src="https://github.com/daniel-mizsak/python-package-template/actions/workflows/ci.yml/badge.svg" alt="build status"></a>
+        <a href="https://codecov.io/gh/daniel-mizsak/python-package-template" target="_blank"><img src="https://codecov.io/gh/daniel-mizsak/python-package-template/graph/badge.svg?token=SDXG1S8PVM" alt="codecov"></a>
+        <a href="https://results.pre-commit.ci/latest/github/daniel-mizsak/python-package-template/main" target="_blank"><img src="https://results.pre-commit.ci/badge/github/daniel-mizsak/python-package-template/main.svg" alt="pre-commit.ci status"></a>
+        <a href="https://pypi.org/project/python-package-template-pypi" target="_blank"><img src="https://img.shields.io/pypi/v/python-package-template-pypi" alt="pypi version"></a>
+        <a href="https://img.shields.io/github/license/daniel-mizsak/python-package-template" target="_blank"><img src="https://img.shields.io/github/license/daniel-mizsak/python-package-template" alt="license"></a>
+    </kbd>
+</div>
+
+## Overview
+
+Python package template configuration.
+
+## Getting started
+
+> [!CAUTION]
+> This template represents my personal understanding of the current best practices.\
+> It is advised to do further research before implementing these configurations in your environment.
+
+Documentation is available at the [GitHub Pages of this repository](https://daniel-mizsak.github.io/python-package-template).
+
+<hr>
+
+<div align="center">
+    <strong>⭐ Star the repository if you found it useful ⭐</strong>
+    <br>
+    <a href="https://github.com/daniel-mizsak/repository-template" target="_blank">Repository Template</a> |
+    <a href="https://github.com/daniel-mizsak/workflows" target="_blank">Reusable Workflows</a> |
+    <a href="https://github.com/daniel-mizsak/mtjd" target="_blank">Development Environment </a>
+</div>

python_package_template_pypi-0.3.0/pyproject.toml

@@ -0,0 +1,47 @@
+# Build System
+[build-system]
+  requires = ["uv_build"]
+  build-backend = "uv_build"
+
+# Project Metadata
+[project]
+  name = "python-package-template-pypi" # Name has to be unique on pypi.
+  version = "0.3.0"
+  description = "Python package template configuration."
+  readme = "README.md"
+  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.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+  ]
+  requires-python = ">=3.12"
+  dependencies = ["numpy==2.4.1"]
+
+  [project.urls]
+    Repository = "https://github.com/daniel-mizsak/python-package-template/"
+    Documentation = "https://daniel-mizsak.github.io/python-package-template/"
+    Issues = "https://github.com/daniel-mizsak/python-package-template/issues/"
+
+[dependency-groups]
+  dev = ["coverage", "mypy", "nox", "pre-commit", "pytest", "ruff"]
+  docs = ["zensical", "mkdocstrings-python"]
+
+# Tools
+# Uv
+[tool.uv.build-backend]
+  module-root = "src"
+  module-name = "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

{python_package_template_pypi-0.2.3 → python_package_template_pypi-0.3.0}/src/python_package_template/__init__.py

@@ -1,12 +1,9 @@
 """
-Init file for the package.
+Python package template configuration.
 
 @author "Daniel Mizsak" <info@pythonvilag.hu>
 """
 
-import importlib.metadata
-
 from python_package_template.main import add_five, subtract_three
 
 __all__ = ["add_five", "subtract_three"]
-__version__ = importlib.metadata.version("python-package-template-pypi")

{python_package_template_pypi-0.2.3 → python_package_template_pypi-0.3.0}/src/python_package_template/main.py

@@ -7,25 +7,25 @@ Main module of the package.
 import numpy as np
 
 
-def add_five(x: int) -> int:
+def add_five(number: int) -> int:
     """Increment the input by 5.
 
     Args:
-        x (int): The input number.
+        number (int): The input number.
 
     Returns:
         int: The input incremented by 5.
     """
-    return x + 5
+    return number + 5
 
 
-def subtract_three(x: int) -> int:
+def subtract_three(number: int) -> int:
     """Decrement the input by 3.
 
     Args:
-        x (int): The input number.
+        number (int): The input number.
 
     Returns:
         int: The input decremented by 3.
     """
-    return int(np.subtract(x, 3))
+    return int(np.subtract(number, 3))

python_package_template_pypi-0.2.3/.devcontainer/Dockerfile

@@ -1,19 +0,0 @@
-ARG BASE_IMAGE=python:3.12
-FROM ${BASE_IMAGE}
-LABEL maintainer="Daniel Mizsak"
-
-ARG USER=vscode
-ENV DEBIAN_FRONTEND=noninteractive
-ENV LANG=C.UTF-8
-ENV TZ=Europe/Copenhagen
-
-RUN apt update --quiet --quiet --yes && \
-    apt install --no-install-recommends --quiet --quiet --yes \
-    build-essential \
-    curl \
-    git && \
-    apt clean --quiet --quiet && \
-    rm --recursive --force /var/lib/apt/lists/* && \
-    rm --recursive --force /tmp/*
-
-WORKDIR /workspace

python_package_template_pypi-0.2.3/.devcontainer/compose.yml

@@ -1,15 +0,0 @@
----
-# Documentation:
-#   - https://code.visualstudio.com/docs/devcontainers/create-dev-container#_use-docker-compose
-#   - https://stackoverflow.com/questions/69635634/how-to-use-vs-code-dev-container-with-existing-docker-compose-file
-#   - https://xebia.com/blog/how-to-create-a-devcontainer-for-your-python-project/
-
-services:
-  ppt-devcontainer:
-    build:
-      context: ..
-      dockerfile: .devcontainer/Dockerfile
-    container_name: ppt-devcontainer
-    tty: true
-    volumes:
-      - ../:/workspace

python_package_template_pypi-0.2.3/.devcontainer/devcontainer.json

@@ -1,25 +0,0 @@
-{
-  "name": "Python Package Template Development Environment",
-  "dockerComposeFile": "compose.yml",
-  "service": "ppt-devcontainer",
-  "workspaceFolder": "/workspace",
-  "postCreateCommand": "pip install -e '.[dev]'",
-  "customizations": {
-    "vscode": {
-      "python.defaultInterpreterPath": "/usr/local/bin/python",
-      "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",
-        "mechatroner.rainbow-csv",
-        "charliermarsh.ruff"
-      ]
-    }
-  }
-}

python_package_template_pypi-0.2.3/.github/CODEOWNERS

@@ -1 +0,0 @@
-*       @daniel-mizsak

python_package_template_pypi-0.2.3/.github/ISSUE_TEMPLATE/bug.yml

@@ -1,42 +0,0 @@
----
-name: Bug report
-description: Create a report to help us improve.
-labels: ["bug"]
-title: "[BUG]: "
-assignees:
-  - daniel-mizsak
-
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for taking the time to fill out this bug report!
-
-  - type: input
-    id: version
-    attributes:
-      label: Package version
-      placeholder: vX.Y.Z
-    validations:
-      required: true
-
-  - type: dropdown
-    id: os
-    attributes:
-      label: Operating system
-      description: The operating system you are using.
-      options:
-        - Windows
-        - macOS
-        - Linux
-      default: 0
-    validations:
-      required: true
-
-  - type: textarea
-    id: bug
-    attributes:
-      label: Bug description
-      description: A clear and concise description of what the bug is.
-    validations:
-      required: true

python_package_template_pypi-0.2.3/.github/ISSUE_TEMPLATE/config.yml

@@ -1,10 +0,0 @@
-# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
-blank_issues_enabled: true
-contact_links:
-  - name: Documentation
-    url: https://python-package-template-pypi.readthedocs.io/en/latest/
-    about: Check the documentation before opening an issue.
-
-  - name: PyPA Code of Conduct
-    url: https://www.pypa.io/en/latest/code-of-conduct/
-    about: Read and follow the PyPA Code of Conduct.

python_package_template_pypi-0.2.3/.github/ISSUE_TEMPLATE/feature.yml

@@ -1,21 +0,0 @@
----
-name: Feature request
-description: Suggest an idea for this project.
-labels: ["enhancement"]
-title: "[FEATURE]: "
-assignees:
-  - daniel-mizsak
-
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for taking the time to fill out this feature request!
-
-  - type: textarea
-    id: feature
-    attributes:
-      label: Feature description
-      description: A clear and concise description of what the feature is.
-    validations:
-      required: true

python_package_template_pypi-0.2.3/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,3 +0,0 @@
-- [ ] Linting passes
-- [ ] Tests are added and passing
-- [ ] Documentation is updated

python_package_template_pypi-0.2.3/.github/dependabot.yml

@@ -1,13 +0,0 @@
----
-version: 2
-
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-
-  - package-ecosystem: "pip"
-    directory: "/"
-    schedule:
-      interval: "weekly"

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

@@ -1,24 +0,0 @@
----
-name: CI
-on:
-  workflow_dispatch:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
-  schedule:
-    - cron: '0 12 * * 6'  # Every Saturday at 12:00
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  tox:
-    uses: daniel-mizsak/workflows/.github/workflows/tox.yml@main
-    with:
-      python_versions: "['3.11', '3.12']"
-      codecov: true
-    secrets: inherit

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

@@ -1,45 +0,0 @@
----
-name: release
-on:
-  push:
-    tags:
-      - "*"
-
-jobs:
-  tox:
-    uses: daniel-mizsak/workflows/.github/workflows/tox.yml@main
-    with:
-      python_versions: "['3.11', '3.12']"
-      codecov: true
-    secrets: inherit
-
-
-  pypi-publish:
-    needs: tox
-    runs-on: ubuntu-latest
-    permissions:
-      id-token: write
-
-    steps:
-      - name: Download build artifacts
-        uses: actions/download-artifact@v4
-        with:
-          name: build
-          path: dist
-
-      - name: Publish build artifacts to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-
-
-  gh-pages-publish:
-    needs: tox
-    runs-on: ubuntu-latest
-    permissions:
-      pages: write
-      id-token: write
-
-    steps:
-      - name: Publish to GitHub Pages
-        uses: actions/deploy-pages@v4
-        with:
-          artifact_name: docs

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

@@ -1,24 +0,0 @@
----
-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.2.3/.gitignore

@@ -1,42 +0,0 @@
-# Project
-
-# System
-.DS_Store
-*.log
-
-# Byte-compiled
-__pycache__/
-*.py[cod]
-*$py.class
-
-# Distribution / Packaging
-.eggs/
-*.egg
-*.egg-info/
-build/
-dist/
-eggs/
-sdist/
-wheels/
-
-# Unit test / Coverage reports
-.coverage
-.mypy_cache
-.pytest_cache
-.ruff_cache
-.tox
-coverage.xml
-htmlcov/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# Environments
-.env
-.venv
-env/
-venv/
-
-# IDE
-.idea/
-.vscode/

python_package_template_pypi-0.2.3/.pre-commit-config.yaml

@@ -1,46 +0,0 @@
-# See https://pre-commit.com for more information
-# See https://pre-commit.com/hooks.html for more hooks
-
-# exclude: ""
-
-# pre-commit ci
-ci:
-  autoupdate_schedule: monthly
-
-# pre-commit
-repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
-    hooks:
-      - id: check-added-large-files
-        args: [--maxkb=2000]
-      - id: check-docstring-first
-      - id: check-merge-conflict
-      - id: check-toml
-      - id: check-yaml
-      - id: detect-private-key
-      - id: end-of-file-fixer
-      - id: name-tests-test
-      - id: trailing-whitespace
-
-  # gitleaks
-  - repo: https://github.com/gitleaks/gitleaks
-    rev: v8.22.1
-    hooks:
-      - id: gitleaks
-
-  # ruff
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.8.6
-    hooks:
-      # Ruff linting
-      - id: ruff
-        args: [--line-length=120]
-      # Ruff formatting
-      - id: ruff-format
-
-  # codespell
-  - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
-    hooks:
-      - id: codespell