cookiecutter-pypackage 0.2.0__tar.gz → 0.3.0__tar.gz

cookiecutter_pypackage-0.3.0/.gitignore

@@ -0,0 +1,210 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.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
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# 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
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# 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/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+
+######### Added custom Cookiecutter PyPackage generated dirs here
+output/
+python_boilerplate/
+cookiecutter-pypackage-env/
+python-boilerplate/

cookiecutter_pypackage-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Audrey M. Roy Greenfeld
+
+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.

cookiecutter_pypackage-0.3.0/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: cookiecutter-pypackage
+Version: 0.3.0
+Summary: Cookiecutter template for a Python package
+Project-URL: homepage, https://github.com/audreyfeldroy/cookiecutter-pypackage
+Author-email: "Audrey M. Roy Greenfeld" <audrey@feldroy.com>
+License: MIT
+License-File: LICENSE
+Keywords: cookiecutter,package,template
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development
+Requires-Python: >=3.10
+Requires-Dist: alabaster>=1.0.0
+Requires-Dist: cookiecutter>=2.6.0
+Requires-Dist: typer>=0.16.0
+Requires-Dist: watchdog>=6.0.0
+Provides-Extra: test
+Requires-Dist: coverage; extra == 'test'
+Requires-Dist: ipdb; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cookies; extra == 'test'
+Requires-Dist: ruff; extra == 'test'
+Requires-Dist: ty; extra == 'test'
+Description-Content-Type: text/markdown
+
+# Cookiecutter PyPackage
+
+[![PyPI version](https://img.shields.io/pypi/v/cookiecutter-pypackage.svg)](https://pypi.python.org/pypi/cookiecutter-pypackage)
+[![PyPI downloads](https://img.shields.io/pypi/dm/cookiecutter-pypackage.svg)](https://pypi.python.org/pypi/cookiecutter-pypackage)
+
+[Cookiecutter](https://github.com/cookiecutter/cookiecutter) template for a Python package.
+
+*   GitHub repo: [https://github.com/audreyfeldroy/cookiecutter-pypackage/](https://github.com/audreyfeldroy/cookiecutter-pypackage/)
+*   Free software: MIT license
+*   Discord: [https://discord.gg/PWXJr3upUE](https://discord.gg/PWXJr3upUE)
+
+## Features
+
+*   Testing setup with pytest
+*   GitHub Actions testing: Setup to easily test for Python 3.10, 3.11, 3.12, and 3.13
+*   Auto-release to [PyPI](https://pypi.python.org/pypi) when you push a new tag to main (optional)
+*   Command line interface using Typer
+
+## Quickstart
+
+Install the latest Cookiecutter if you haven't installed it yet:
+
+```bash
+pip install -U cookiecutter
+```
+
+Generate a Python package project:
+
+```bash
+cookiecutter https://github.com/audreyfeldroy/cookiecutter-pypackage.git
+```
+
+Then:
+
+*   Create a repo and put it there.
+*   [Register](https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives) your project with PyPI.
+*   Add the repo to your [Read the Docs](https://readthedocs.io/) account + turn on the Read the Docs service hook.
+*   Release your package by pushing a new tag to main.
+
+## Not Exactly What You Want?
+
+Don't worry, you have options:
+
+### Fork This / Create Your Own
+
+If you have differences in your preferred setup, I encourage you to fork this
+to create your own version. Or create your own; it doesn't strictly have to
+be a fork.
+
+### Similar Cookiecutter Templates
+
+Explore other forks to get ideas. See the [network](https://github.com/audreyfeldroy/cookiecutter-pypackage/network) and [family tree](https://github.com/audreyfeldroy/cookiecutter-pypackage/network/members) for this repo.
+
+### Or Submit a Pull Request
+
+I also accept pull requests on this, if they're small, atomic, and if they
+make my own packaging experience better.

cookiecutter_pypackage-0.3.0/README.md

@@ -0,0 +1,57 @@
+# Cookiecutter PyPackage
+
+[![PyPI version](https://img.shields.io/pypi/v/cookiecutter-pypackage.svg)](https://pypi.python.org/pypi/cookiecutter-pypackage)
+[![PyPI downloads](https://img.shields.io/pypi/dm/cookiecutter-pypackage.svg)](https://pypi.python.org/pypi/cookiecutter-pypackage)
+
+[Cookiecutter](https://github.com/cookiecutter/cookiecutter) template for a Python package.
+
+*   GitHub repo: [https://github.com/audreyfeldroy/cookiecutter-pypackage/](https://github.com/audreyfeldroy/cookiecutter-pypackage/)
+*   Free software: MIT license
+*   Discord: [https://discord.gg/PWXJr3upUE](https://discord.gg/PWXJr3upUE)
+
+## Features
+
+*   Testing setup with pytest
+*   GitHub Actions testing: Setup to easily test for Python 3.10, 3.11, 3.12, and 3.13
+*   Auto-release to [PyPI](https://pypi.python.org/pypi) when you push a new tag to main (optional)
+*   Command line interface using Typer
+
+## Quickstart
+
+Install the latest Cookiecutter if you haven't installed it yet:
+
+```bash
+pip install -U cookiecutter
+```
+
+Generate a Python package project:
+
+```bash
+cookiecutter https://github.com/audreyfeldroy/cookiecutter-pypackage.git
+```
+
+Then:
+
+*   Create a repo and put it there.
+*   [Register](https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives) your project with PyPI.
+*   Add the repo to your [Read the Docs](https://readthedocs.io/) account + turn on the Read the Docs service hook.
+*   Release your package by pushing a new tag to main.
+
+## Not Exactly What You Want?
+
+Don't worry, you have options:
+
+### Fork This / Create Your Own
+
+If you have differences in your preferred setup, I encourage you to fork this
+to create your own version. Or create your own; it doesn't strictly have to
+be a fork.
+
+### Similar Cookiecutter Templates
+
+Explore other forks to get ideas. See the [network](https://github.com/audreyfeldroy/cookiecutter-pypackage/network) and [family tree](https://github.com/audreyfeldroy/cookiecutter-pypackage/network/members) for this repo.
+
+### Or Submit a Pull Request
+
+I also accept pull requests on this, if they're small, atomic, and if they
+make my own packaging experience better.

cookiecutter_pypackage-0.3.0/cookiecutter.json

@@ -0,0 +1,12 @@
+{
+  "full_name": "Audrey M. Roy Greenfeld",
+  "email": "audreyfeldroy@example.com",
+  "github_username": "audreyfeldroy",
+  "pypi_package_name": "python-boilerplate",
+  "project_name": "Python Boilerplate",
+  "project_slug": "{{ cookiecutter.pypi_package_name.replace('-', '_') }}",
+  "project_short_description": "Python Boilerplate contains all the boilerplate you need to create a Python package.",
+  "pypi_username": "{{ cookiecutter.github_username }}",
+  "first_version": "0.1.0",
+  "__gh_slug": "{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}"
+}

cookiecutter_pypackage-0.3.0/hooks/post_gen_project.py

@@ -0,0 +1,4 @@
+#!/usr/bin/env python
+
+if __name__ == "__main__":
+    print("Your Python package project has been created successfully!")

cookiecutter_pypackage-0.3.0/hooks/pre_gen_project.py

@@ -0,0 +1,14 @@
+import re
+import sys
+
+MODULE_REGEX = r"^[_a-zA-Z][_a-zA-Z0-9]+$"
+
+module_name = "{{ cookiecutter.project_slug}}"
+
+if not re.match(MODULE_REGEX, module_name):
+    print(
+        "ERROR: The project slug (%s) is not a valid Python module name. "
+        "Please do not use a - and use _ instead" % module_name
+    )
+    # Exit to cancel project
+    sys.exit(1)

cookiecutter_pypackage-0.3.0/pyproject.toml

@@ -0,0 +1,83 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "cookiecutter-pypackage"
+version = "0.3.0"
+description = "Cookiecutter template for a Python package"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+authors = [
+    { name = "Audrey M. Roy Greenfeld", email = "audrey@feldroy.com" }
+]
+keywords = ["cookiecutter", "template", "package"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Topic :: Software Development",
+]
+dependencies = [
+    "cookiecutter>=2.6.0",
+    "typer>=0.16.0",
+    "alabaster>=1.0.0",
+    "watchdog>=6.0.0",
+]
+
+[project.optional-dependencies]
+test = [
+    "coverage",  # testing
+    "pytest",  # testing
+    "pytest-cookies",  # testing
+    "ruff",  # linting
+    "ty", # checking types
+    "ipdb"
+]
+
+[project.scripts]
+cookiecutter-pypackage = "cookiecutter_pypackage.cli:app"
+
+[project.urls]
+homepage = "https://github.com/audreyfeldroy/cookiecutter-pypackage"
+
+[tool.ruff]
+exclude = [
+    "*cookiecutter.pypi_package_name*"
+    ]
+
+[tool.pytest.ini_options]
+testpaths = [
+    "tests",
+]
+
+[dependency-groups]
+dev = [
+    "rust-just>=1.42.4",
+]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "src/",
+    "cookiecutter.json",
+    "hooks/",
+    "{{cookiecutter.pypi_package_name}}/",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/cookiecutter_pypackage"]
+
+[tool.hatch.build.targets.wheel.force-include]
+"cookiecutter.json" = "cookiecutter_pypackage/template/cookiecutter.json"
+"hooks" = "cookiecutter_pypackage/template/hooks"
+"{{cookiecutter.pypi_package_name}}" = "cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}"

cookiecutter_pypackage-0.3.0/src/cookiecutter_pypackage/__init__.py

@@ -0,0 +1,3 @@
+"""Cookiecutter PyPackage - A modern Python package template."""
+
+__version__ = "0.3.0"

cookiecutter_pypackage-0.3.0/src/cookiecutter_pypackage/cli.py

@@ -0,0 +1,43 @@
+"""CLI for cookiecutter-pypackage.
+
+Usage:
+    uvx cookiecutter-pypackage
+    uvx cookiecutter-pypackage --no-input
+    uvx cookiecutter-pypackage -o /path/to/output
+"""
+
+from pathlib import Path
+from typing import Optional
+
+import typer
+from cookiecutter.main import cookiecutter
+
+app = typer.Typer(
+    help="Generate a Python package from the cookiecutter-pypackage template.",
+    add_completion=False,
+)
+
+
+@app.command()
+def main(
+    output_dir: Optional[Path] = typer.Option(
+        None, "--output-dir", "-o", help="Where to output the generated project"
+    ),
+    no_input: bool = typer.Option(
+        False, "--no-input", help="Do not prompt for parameters, use defaults"
+    ),
+) -> None:
+    """Generate a new Python package from the cookiecutter-pypackage template."""
+    # Template is bundled inside the package
+    template_dir = Path(__file__).parent / "template"
+
+    # Run cookiecutter with the bundled template
+    cookiecutter(
+        str(template_dir),
+        output_dir=str(output_dir) if output_dir else ".",
+        no_input=no_input,
+    )
+
+
+if __name__ == "__main__":
+    app()

cookiecutter_pypackage-0.3.0/{{cookiecutter.pypi_package_name}}/.editorconfig

@@ -0,0 +1,37 @@
+# https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{html,css,js,json,sh,yml,yaml}]
+indent_size = 2
+
+[*.bat]
+indent_style = tab
+end_of_line = crlf
+
+[LICENSE]
+insert_final_newline = false
+
+[Makefile]
+indent_style = tab
+indent_size = unset
+
+# Ignore binary or generated files
+[*.{png,jpg,gif,ico,woff,woff2,ttf,eot,svg,pdf}]
+charset = unset
+end_of_line = unset
+indent_style = unset
+indent_size = unset
+trim_trailing_whitespace = unset
+insert_final_newline = unset
+max_line_length = unset
+
+[*.{diff,patch}]
+trim_trailing_whitespace = false

cookiecutter_pypackage-0.3.0/{{cookiecutter.pypi_package_name}}/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,15 @@
+* {{ cookiecutter.project_name }} version:
+* Python version:
+* Operating System:
+
+### Description
+
+Describe what you were trying to get done.
+Tell us what happened, what went wrong, and what you expected to happen.
+
+### What I Did
+
+```
+Paste the command(s) you ran and the output.
+If there was a crash, please include the traceback here.
+```

cookiecutter_pypackage-0.3.0/{{cookiecutter.pypi_package_name}}/.github/workflows/publish.yml

@@ -0,0 +1,16 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags: ['v*']
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # Required for Trusted Publishers
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uv build
+      - uses: pypa/gh-action-pypi-publish@release/v1

cookiecutter_pypackage-0.3.0/{{cookiecutter.pypi_package_name}}/.github/workflows/test.yml

@@ -0,0 +1,39 @@
+# This workflow will install Python dependencies, run tests and lint.
+# For more information see: https://docs.github.com/en/actions/use-cases-and-examples/building-and-testing/building-and-testing-python
+
+name: Test Python application
+
+on:
+  push:
+    branches: [ "main", "master" ]
+  pull_request:
+    branches: [ "main", "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        # Test all supported Python versions under Ubuntu
+        os: [ubuntu-latest]
+        python-version: ['3.12', '3.13', '3.14']
+
+    runs-on: {% raw %}${{ matrix.os }}{% endraw %}
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        python-version: {% raw %}${{ matrix.python-version }}{% endraw %}
+    - name: Lint with ruff
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        uv run ruff check --select=E9,F63,F7,F82
+        # exit-zero treats all errors as warnings
+        uv run ruff check --exit-zero --statistics
+    - name: Run tests
+      run: |
+        uv run pytest