pyprefab 0.2.0__tar.gz

pyprefab-0.2.0/.github/workflows/publish-pypi-test.yml

@@ -0,0 +1,62 @@
+# .github/workflows/publish-pypi-test.yml
+# uses trusted publishing to publish the package to test-pypi as described here:
+# https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+name: Publish to test PyPI
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Set up Python 🐍
+        uses: actions/setup-python@v5
+
+      - name: Install uv 🌟
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: ">=0.0.1"
+
+      - name: Build package for distribution 🛠️
+        run: |
+          uv build
+
+      - name: Upload distribution packages 📤
+        uses: actions/upload-artifact@v4
+        with:
+          name: package-distribution
+          path: dist/
+
+  publish-to-testpypi:
+    name: Publish Python distribution to test PyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi-test
+      url: https://test.pypi.org/p/pyprefab
+    permissions:
+       id-token: write  # needed for trusted publishing (i.e., OIDC)
+
+    steps:
+    - name: Download distribution artifacts 📥
+      uses: actions/download-artifact@v4
+      with:
+        name: package-distribution
+        path: dist/
+    - name: Publish distribution to test PyPI 🚀
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/

pyprefab-0.2.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,104 @@
+# .github/workflows/publish-pypi.yml
+# uses trusted publishing to publish the package to PyPI and create a GitHub
+# release as described here:
+# https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+name: Publish to PyPI and create GitHub release
+
+on:
+  push:
+    tags:
+      # only run workflow for tags in release format
+      - "v[0-9].[0-9].[0-9]"
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Set up Python 🐍
+        uses: actions/setup-python@v5
+
+      - name: Install uv 🌟
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: ">=0.0.1"
+
+      - name: Build package for distribution 🛠️
+        run: |
+          uv build
+
+      - name: Upload distribution packages 📤
+        uses: actions/upload-artifact@v4
+        with:
+          name: package-distribution
+          path: dist/
+
+  publish-to-pypi:
+    name: Publish Python distribution to PyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pyprefab
+    permissions:
+       id-token: write  # needed for trusted publishing (i.e., OIDC)
+
+    steps:
+    - name: Download distribution artifacts 📥
+      uses: actions/download-artifact@v4
+      with:
+        name: package-distribution
+        path: dist/
+    - name: Publish distribution to PyPI 🚀
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: >-
+      Sign the Python distribution with Sigstore
+      and upload them to GitHub Release
+    needs:
+    - publish-to-pypi
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # required for creating GitHub Releases
+      id-token: write  # required for sigstore
+
+    steps:
+    - name: Download distribution artifacts 📥
+      uses: actions/download-artifact@v4
+      with:
+        name: package-distribution
+        path: dist/
+    - name: Sign the dists with Sigstore 📝
+      uses: sigstore/gh-action-sigstore-python@v3.0.0
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+    - name: Create GitHub Release 🛠️
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release create
+        "$GITHUB_REF_NAME"
+        --repo "$GITHUB_REPOSITORY"
+        --notes-from-tag
+    - name: Upload artifact signatures to GitHub Release 📤
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      # Upload to GitHub Release.
+      # `dist/` contains the built packages, and the
+      # sigstore-produced signatures and certificates.
+      run: >-
+        gh release upload
+        "$GITHUB_REF_NAME" dist/**
+        --repo "$GITHUB_REPOSITORY"

pyprefab-0.2.0/.github/workflows/pythonapp-workflow.yml

@@ -0,0 +1,32 @@
+name: run-code-checks
+
+on:
+  push:
+  pull_request:
+    branches: [ $default-branch ]
+
+jobs:
+  run-checks:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout code 🧳
+        uses: actions/checkout@v4
+
+      - name: install uv 🌞
+        uses: astral-sh/setup-uv@v3
+
+      - name: set up Python 🐍
+        uses: actions/setup-python@v5
+
+      - name: install project 🚀
+        run: uv sync --dev
+
+      - name: lint 🧹
+        run: uv run ruff check .
+
+      - name: run tests 🧪
+        run: uv run pytest
+
+      - name: type check ⌨️
+        run: uv run mypy .
+

pyprefab-0.2.0/.gitignore

@@ -0,0 +1,172 @@
+**/.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

pyprefab-0.2.0/.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.8.0
+  hooks:
+    # Run the linter.
+    - id: ruff
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.6.0
+  hooks:
+  - id: trailing-whitespace
+  - id: check-yaml
+    args: [--allow-multiple-documents]
+  - id: debug-statements
+  - id: detect-aws-credentials
+    args: [--allow-missing-credentials]
+  - id: detect-private-key
+  - id: double-quote-string-fixer
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 'v1.10.1'  # Use the sha / tag you want to point at
+    hooks:
+    -   id: mypy
+        additional_dependencies: [types-all]
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.3.0
+  hooks:
+  - id: codespell

pyprefab-0.2.0/.python-version

@@ -0,0 +1 @@
+3.12

pyprefab-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Becky Sweger
+
+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.

pyprefab-0.2.0/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.2
+Name: pyprefab
+Version: 0.2.0
+Summary: Python application template for personal use
+License: MIT License
+Project-URL: Repository, https://github.com/bsweger/pyprefab.git
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: structlog
+Requires-Dist: rich
+
+# pyprefab
+
+A Python template for personal use. The package itself doesn't do much, but I
+keep it up to date as my Python workflow and tooling preferences evolve.
+
+## Installing and running the package (no development)
+
+To install this package via pip:
+
+```bash
+pip install git+https://github.com/bsweger/pyprefab.git
+```
+
+To run it:
+
+```bash
+hello_world
+```
+
+## Setup for local development
+
+The instructions below outline how to set up a development environment based
+on uv tooling.
+
+Prerequisites:
+
+- [uv](https://docs.astral.sh/uv/getting-started/installation/)
+
+1. Clone this repository
+2. Change to the repo's root directory:
+
+    ```bash
+    cd pyprefab
+    ```
+
+3. Create a Python virtual environment and install dependencies. The command
+below creates a virtual environment in the `.venv` directory, installs Python
+if needed, installs project dependencies (including dev dependencies), and
+installs the package in
+[editable mode](https://setuptools.pypa.io/en/stable/userguide/development_mode.html):
+
+    ```bash
+    uv sync
+    ```
+
+4. Run the test suite to confirm that everything is working:
+
+    ```bash
+    uv run pytest
+    ```
+
+### Updating dependencies
+
+Use [`uv add`](https://docs.astral.sh/uv/reference/cli/#uv-add) to include a
+new dependency in the project. This command will install the new dependency
+into the virtual environment, add it to `uv.lock`, and update the
+`dependencies` section of [`pyproject.toml`](pyproject.toml).
+
+```bash
+uv add <package-name>
+```
+
+To add a dependency to a specific group (adding a dev dependency, for example),
+use the `--group` flag:
+
+```bash
+uv add <package-name> --group dev
+```

pyprefab-0.2.0/README.md

@@ -0,0 +1,68 @@
+# pyprefab
+
+A Python template for personal use. The package itself doesn't do much, but I
+keep it up to date as my Python workflow and tooling preferences evolve.
+
+## Installing and running the package (no development)
+
+To install this package via pip:
+
+```bash
+pip install git+https://github.com/bsweger/pyprefab.git
+```
+
+To run it:
+
+```bash
+hello_world
+```
+
+## Setup for local development
+
+The instructions below outline how to set up a development environment based
+on uv tooling.
+
+Prerequisites:
+
+- [uv](https://docs.astral.sh/uv/getting-started/installation/)
+
+1. Clone this repository
+2. Change to the repo's root directory:
+
+    ```bash
+    cd pyprefab
+    ```
+
+3. Create a Python virtual environment and install dependencies. The command
+below creates a virtual environment in the `.venv` directory, installs Python
+if needed, installs project dependencies (including dev dependencies), and
+installs the package in
+[editable mode](https://setuptools.pypa.io/en/stable/userguide/development_mode.html):
+
+    ```bash
+    uv sync
+    ```
+
+4. Run the test suite to confirm that everything is working:
+
+    ```bash
+    uv run pytest
+    ```
+
+### Updating dependencies
+
+Use [`uv add`](https://docs.astral.sh/uv/reference/cli/#uv-add) to include a
+new dependency in the project. This command will install the new dependency
+into the virtual environment, add it to `uv.lock`, and update the
+`dependencies` section of [`pyproject.toml`](pyproject.toml).
+
+```bash
+uv add <package-name>
+```
+
+To add a dependency to a specific group (adding a dev dependency, for example),
+use the `--group` flag:
+
+```bash
+uv add <package-name> --group dev
+```

pyprefab-0.2.0/pyproject.toml

@@ -0,0 +1,66 @@
+[project]
+name = 'pyprefab'
+description = 'Python application template for personal use'
+license = {text = 'MIT License'}
+readme = 'README.md'
+requires-python = '>=3.9'
+classifiers = [
+    'Programming Language :: Python :: 3',
+    'License :: OSI Approved :: MIT License',
+]
+dynamic = ['version']
+
+dependencies = [
+    'structlog',
+    'rich',
+]
+
+[dependency-groups]
+dev = [
+    'coverage',
+    'freezegun',
+    'mypy',
+    'pre-commit',
+    'pytest',
+    "pytest-random-order>=1.1.1",
+    'ruff',
+]
+
+[project.urls]
+Repository = "https://github.com/bsweger/pyprefab.git"
+
+[project.entry-points.'console_scripts']
+hello_world = 'hello_world.app:main'
+
+[build-system]
+# Minimum requirements for the build system to execute.
+requires = ['setuptools', 'wheel', "setuptools_scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+namespaces = true
+where = ["src"]
+
+[tool.setuptools_scm]
+local_scheme = "no-local-version"
+
+[tool.hello_world]
+# to write json-formatted logs to disk, uncomment the following line specify the file location
+# log_file = '/path/to/logs/files/hello_world.log'
+
+[tool.pytest.ini_options]
+addopts = "--random-order"
+tmp_path_retention_policy = "none"
+testpaths = [
+    "tests",
+]
+
+[tool.ruff]
+line-length = 120
+lint.extend-select = ['I', 'Q']
+
+[tool.ruff.lint.flake8-quotes]
+inline-quotes = 'single'
+
+[tool.ruff.format]
+quote-style = 'single'

pyprefab-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pyprefab-0.2.0/src/hello_world/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.0.3'

pyprefab-0.2.0/src/hello_world/app.py

@@ -0,0 +1,20 @@
+import structlog
+
+from hello_world.util.date import get_current_date
+from hello_world.util.logs import setup_logging
+
+setup_logging()
+logger = structlog.get_logger()
+
+
+def main():
+    """Application entry point."""
+
+    today = get_current_date()
+    logger.info('retrieved the date', date=today)
+
+    return f'Hello, today is {today}!'
+
+
+if __name__ == '__main__':
+    main()

pyprefab-0.2.0/src/hello_world/util/date.py

@@ -0,0 +1,15 @@
+import datetime
+
+import structlog
+
+logger = structlog.get_logger()
+
+
+def get_current_date() -> str:
+    """Return current date in human-readable format."""
+
+    logger.info('getting the current date')
+    current_date = datetime.datetime.now()
+    formatted_date = current_date.strftime('%B %d, %Y')
+
+    return formatted_date