cookiecutter-pypackage 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

cookiecutter_pypackage/__init__.py

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

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/template/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/template/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/template/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/template/{{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/template/{{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/template/{{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/template/{{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

cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/.gitignore

@@ -0,0 +1,205 @@
+# From https://github.com/github/gitignore/blob/main/Python.gitignore 2025-07-30
+
+# 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

cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/CODE_OF_CONDUCT.md

@@ -0,0 +1,89 @@
+# Contributor Covenant 3.0
+
+## Our Pledge
+
+We pledge to make our community welcoming, safe, and equitable for all.
+
+We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
+
+
+## Encouraged Behaviors
+
+While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
+
+With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
+
+1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
+2. Engaging **kindly and honestly** with others.
+3. Respecting **different viewpoints** and experiences.
+4. **Taking responsibility** for our actions and contributions.
+5. Gracefully giving and accepting **constructive feedback**.
+6. Committing to **repairing harm** when it occurs.
+7. Behaving in other ways that promote and sustain the **well-being of our community**.
+
+
+## Restricted Behaviors
+
+We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
+
+1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
+2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
+3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
+4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
+5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
+6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
+7. Behaving in other ways that **threaten the well-being** of our community.
+
+### Other Restrictions
+
+1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
+2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
+3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
+4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
+
+
+## Reporting an Issue
+
+Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
+
+When an incident does occur, it is important to report it promptly. To report a possible violation, email {{ cookiecutter.email }}.
+
+Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
+
+
+## Addressing and Repairing Harm
+
+If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
+
+1) Warning
+   1) Event: A violation involving a single incident or series of incidents.
+   2) Consequence: A private, written warning from the Community Moderators.
+   3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
+2) Temporarily Limited Activities
+   1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
+   2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
+   3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
+3) Temporary Suspension
+   1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
+   2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
+   3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
+4) Permanent Ban
+   1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
+   2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
+   3) Repair: There is no possible repair in cases of this severity.
+
+This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
+
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
+
+Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
+
+For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion).

cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/CONTRIBUTING.md

@@ -0,0 +1,119 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+## Types of Contributions
+
+### Report Bugs
+
+Report bugs at https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/issues.
+
+If you are reporting a bug, please include:
+
+- Your operating system name and version.
+- Any details about your local setup that might be helpful in troubleshooting.
+- Detailed steps to reproduce the bug.
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
+
+### Implement Features
+
+Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
+
+### Write Documentation
+
+{{ cookiecutter.project_name }} could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
+
+### Submit Feedback
+
+The best way to send feedback is to file an issue at https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/issues.
+
+If you are proposing a feature:
+
+- Explain in detail how it would work.
+- Keep the scope as narrow as possible, to make it easier to implement.
+- Remember that this is a volunteer-driven project, and that contributions are welcome :)
+
+## Get Started!
+
+Ready to contribute? Here's how to set up `{{ cookiecutter.project_slug }}` for local development.
+
+1. Fork the `{{ cookiecutter.project_slug }}` repo on GitHub.
+2. Clone your fork locally:
+
+   ```sh
+   git clone git@github.com:your_name_here/{{ cookiecutter.project_slug }}.git
+   ```
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
+
+   ```sh
+   mkvirtualenv {{ cookiecutter.project_slug }}
+   cd {{ cookiecutter.project_slug }}/
+   python setup.py develop
+   ```
+
+4. Create a branch for local development:
+
+   ```sh
+   git checkout -b name-of-your-bugfix-or-feature
+   ```
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
+
+   ```sh
+   make lint
+   make test
+   # Or
+   make test-all
+   ```
+
+   To get flake8 and tox, just pip install them into your virtualenv.
+
+6. Commit your changes and push your branch to GitHub:
+
+   ```sh
+   git add .
+   git commit -m "Your detailed description of your changes."
+   git push origin name-of-your-bugfix-or-feature
+   ```
+
+7. Submit a pull request through the GitHub website.
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
+3. The pull request should work for Python 3.12 and 3.13. Tests run in GitHub Actions on every pull request to the main branch, make sure that the tests pass for all supported Python versions.
+
+## Tips
+
+To run a subset of tests:
+
+```sh
+pytest tests.test_{{ cookiecutter.project_slug }}
+```
+
+## Deploying
+
+A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.md). Then run:
+
+```sh
+uv version patch  # or: minor, major
+git commit -am "Release X.Y.Z"
+just tag
+```
+
+GitHub Actions will automatically publish to PyPI when the tag is pushed. See `.github/workflows/publish.yml` for details.
+
+## Code of Conduct
+
+Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.

cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/HISTORY.md

@@ -0,0 +1,5 @@
+# History
+
+## {{ cookiecutter.first_version }} ({% now 'local' %})
+
+* First release on PyPI.

cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) {% now 'local', '%Y' %}, {{ cookiecutter.full_name }}
+
+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/template/{{cookiecutter.pypi_package_name}}/MANIFEST.in

@@ -0,0 +1,10 @@
+include CONTRIBUTING.md
+include HISTORY.md
+include LICENSE
+include README.md
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.md Makefile *.jpg *.png *.gif

cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/README.md

@@ -0,0 +1,18 @@
+# {{ cookiecutter.project_name }}
+
+![PyPI version](https://img.shields.io/pypi/v/{{ cookiecutter.pypi_package_name }}.svg)
+[![Documentation Status](https://readthedocs.org/projects/{{ cookiecutter.pypi_package_name }}/badge/?version=latest)](https://{{ cookiecutter.pypi_package_name }}.readthedocs.io/en/latest/?version=latest)
+
+{{ cookiecutter.project_short_description }}
+
+* PyPI package: https://pypi.org/project/{{ cookiecutter.pypi_package_name }}/
+* Free software: MIT License
+* Documentation: https://{{ cookiecutter.pypi_package_name }}.readthedocs.io.
+
+## Features
+
+* TODO
+
+## Credits
+
+This package was created with [Cookiecutter](https://github.com/audreyfeldroy/cookiecutter) and the [audreyfeldroy/cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage) project template.

cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/docs/index.md

@@ -0,0 +1,16 @@
+# Welcome to {{ cookiecutter.project_name }}'s documentation!
+
+## Contents
+
+- [Readme](readme.md)
+- [Installation](installation.md)
+- [Usage](usage.md)
+- [Modules](modules.md)
+- [Contributing](contributing.md)
+- [History](history.md)
+
+## Indices and tables
+
+- [Index](genindex)
+- [Module Index](modindex)
+- [Search](search)

cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/docs/installation.md

@@ -0,0 +1,38 @@
+# Installation
+
+## Stable release
+
+To install {{ cookiecutter.project_name }}, run this command in your terminal:
+
+```sh
+uv add {{ cookiecutter.pypi_package_name }}
+```
+
+Or if you prefer to use `pip`:
+
+```sh
+pip install {{ cookiecutter.pypi_package_name }}
+```
+
+## From source
+
+The source files for {{ cookiecutter.project_name }} can be downloaded from the [Github repo](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}).
+
+You can either clone the public repository:
+
+```sh
+git clone git://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}
+```
+
+Or download the [tarball](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/tarball/main):
+
+```sh
+curl -OJL https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/tarball/main
+```
+
+Once you have a copy of the source, you can install it with:
+
+```sh
+cd {{ cookiecutter.project_slug }}
+uv pip install .
+```

cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/docs/usage.md

@@ -0,0 +1,7 @@
+# Usage
+
+To use {{ cookiecutter.project_name }} in a project:
+
+```python
+import {{ cookiecutter.project_slug }}
+```

cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/justfile

@@ -0,0 +1,86 @@
+# Justfile for {{cookiecutter.pypi_package_name}}
+
+# Show available commands
+list:
+    @just --list
+
+# Run all the formatting, linting, and testing commands
+qa:
+    uv run --python=3.13 --extra test ruff format .
+    uv run --python=3.13 --extra test ruff check . --fix
+    uv run --python=3.13 --extra test ruff check --select I --fix .
+    uv run --python=3.13 --extra test ty check .
+    uv run --python=3.13 --extra test pytest .
+
+# Run all the tests for all the supported Python versions
+testall:
+    uv run --python=3.10 --extra test pytest
+    uv run --python=3.11 --extra test pytest
+    uv run --python=3.12 --extra test pytest
+    uv run --python=3.13 --extra test pytest
+
+# Run all the tests, but allow for arguments to be passed
+test *ARGS:
+    @echo "Running with arg: {{ '{{ARGS}}' }}"
+    uv run --python=3.13 --extra test pytest {{ '{{ARGS}}' }}
+
+# Run all the tests, but on failure, drop into the debugger
+pdb *ARGS:
+    @echo "Running with arg: {{ '{{ARGS}}' }}"
+    uv run --python=3.13  --extra test pytest --pdb --maxfail=10 --pdbcls=IPython.terminal.debugger:TerminalPdb {{ '{{ARGS}}' }}
+
+# Run coverage, and build to HTML
+coverage:
+    uv run --python=3.13 --extra test coverage run -m pytest .
+    uv run --python=3.13 --extra test coverage report -m
+    uv run --python=3.13 --extra test coverage html
+
+# Build the project, useful for checking that packaging is correct
+build:
+    rm -rf build
+    rm -rf dist
+    uv build
+
+VERSION := `grep -m1 '^version' pyproject.toml | sed -E 's/version = "(.*)"/\1/'`
+
+# Print the current version of the project
+version:
+    @echo "Current version is {{ '{{VERSION}}' }}"
+
+# Tag the current version in git and put to github
+tag:
+    echo "Tagging version v{{ '{{VERSION}}' }}"
+    git tag -a v{{ '{{VERSION}}' }} -m "Creating version v{{ '{{VERSION}}' }}"
+    git push origin v{{ '{{VERSION}}' }}
+
+# remove all build, test, coverage and Python artifacts
+clean: 
+	clean-build
+	clean-pyc
+	clean-test
+
+# remove build artifacts
+clean-build:
+	rm -fr build/
+	rm -fr dist/
+	rm -fr .eggs/
+	find . -name '*.egg-info' -exec rm -fr {} +
+	find . -name '*.egg' -exec rm -f {} +
+
+# remove Python file artifacts
+clean-pyc:
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+# remove test and coverage artifacts
+clean-test:
+	rm -f .coverage
+	rm -fr htmlcov/
+	rm -fr .pytest_cache
+
+# Publish to PyPI (manual alternative to GitHub Actions)
+publish:
+    uv build
+    uv publish

cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/pyproject.toml

@@ -0,0 +1,58 @@
+[project]
+name = "{{cookiecutter.pypi_package_name}}"
+version = "{{ cookiecutter.first_version }}"
+description = "{{ cookiecutter.project_short_description | replace('\\', '\\\\') | replace('\"', '\\\"') }}"
+readme = "README.md"
+authors = [
+  {name = "{{ cookiecutter.full_name | replace('\\', '\\\\') | replace('\"', '\\\"') }}", email = "{{cookiecutter.email}}"}
+]
+maintainers = [
+  {name = "{{ cookiecutter.full_name | replace('\\', '\\\\') | replace('\"', '\\\"') }}", email = "{{cookiecutter.email}}"}
+]
+classifiers = [
+    # TODO
+]
+license = {text = "MIT"}
+dependencies = [
+  "typer",
+  "rich",
+]
+requires-python = ">= 3.10"
+
+[project.optional-dependencies]
+test = [
+    "coverage",  # testing
+    "pytest",  # testing
+    "ruff",  # linting
+    "ty", # checking types
+    "ipdb", # debugging
+]
+
+[project.urls]
+bugs = "https://github.com/{{cookiecutter.__gh_slug}}/issues"
+changelog = "https://github.com/{{cookiecutter.__gh_slug}}/blob/main/changelog.md"
+homepage = "https://github.com/{{cookiecutter.__gh_slug}}"
+
+[project.scripts]
+{{cookiecutter.project_slug}} = "{{cookiecutter.project_slug}}.cli:app"
+
+[tool.ty]
+# All rules are enabled as "error" by default; no need to specify unless overriding.
+# Example override: relax a rule for the entire project (uncomment if needed).
+# rules.TY015 = "warn"  # For invalid-argument-type, warn instead of error.
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # Pyflakes
+    "I",   # isort
+    "B",   # flake8-bugbear
+    "UP",  # pyupgrade
+]
+
+[tool.uv]
+package = true

cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/src/{{cookiecutter.project_slug}}/__init__.py

@@ -0,0 +1,4 @@
+"""Top-level package for {{ cookiecutter.project_name }}."""
+
+__author__ = """{{ cookiecutter.full_name }}"""
+__email__ = '{{ cookiecutter.email }}'

cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/src/{{cookiecutter.project_slug}}/__main__.py

@@ -0,0 +1,4 @@
+from .cli import app
+
+if __name__ == "__main__":
+    app()

cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/src/{{cookiecutter.project_slug}}/cli.py

@@ -0,0 +1,22 @@
+"""Console script for {{cookiecutter.project_slug}}."""
+
+import typer
+from rich.console import Console
+
+from {{cookiecutter.project_slug}} import utils
+
+app = typer.Typer()
+console = Console()
+
+
+@app.command()
+def main():
+    """Console script for {{cookiecutter.project_slug}}."""
+    console.print("Replace this message by putting your code into "
+               "{{cookiecutter.project_slug}}.cli.main")
+    console.print("See Typer documentation at https://typer.tiangolo.com/")
+    utils.do_something_useful()
+
+
+if __name__ == "__main__":
+    app()

cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/src/{{cookiecutter.project_slug}}/utils.py

@@ -0,0 +1,2 @@
+def do_something_useful():
+    print("Replace this with a utility function")

cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/src/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}.py

@@ -0,0 +1 @@
+"""Main module."""

cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/tests/__init__.py

@@ -0,0 +1 @@
+"""Unit test package for {{ cookiecutter.project_slug }}."""

cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/tests/test_{{cookiecutter.project_slug}}.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+import pytest
+
+"""Tests for `{{ cookiecutter.project_slug }}` package."""
+
+# from {{ cookiecutter.project_slug }} import {{ cookiecutter.project_slug }}
+
+
+@pytest.fixture
+def response():
+    """Sample pytest fixture.
+
+    See more at: http://doc.pytest.org/en/latest/fixture.html
+    """
+    # import requests
+    # return requests.get('https://github.com/audreyfeldroy/cookiecutter-pypackage')
+
+
+def test_content(response):
+    """Sample pytest test function with the pytest fixture as an argument."""
+    # from bs4 import BeautifulSoup
+    # assert 'GitHub' in BeautifulSoup(response.content).title.string

cookiecutter_pypackage-0.3.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,33 @@
+cookiecutter_pypackage/__init__.py,sha256=wsBDAjiroEMi6F3b3GmCu2jSywyuF1SqYvwCagCoQQM,88
+cookiecutter_pypackage/cli.py,sha256=P5-1gkljvw0y5UyuU5a1Kb08LyIn3N0Ttr9VMqYOEiw,1110
+cookiecutter_pypackage/template/cookiecutter.json,sha256=vwW0v8LRT61tu4rN_Ci6VRjD9992qaYayG2jLaQ9_OA,573
+cookiecutter_pypackage/template/hooks/post_gen_project.py,sha256=AS4vyATxgPwT4D8svzUTpApYcuBz_abnmu6b9b5zdCA,122
+cookiecutter_pypackage/template/hooks/pre_gen_project.py,sha256=Q2LgpeI-JztI1t47_QzXYIL7xMUrriQfY1YP1-lquJ4,359
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/.editorconfig,sha256=ApOhM0df3iTTbSwBnjtEwYDx-MsgDzAS9C9mylQlZW8,663
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/.gitignore,sha256=Zuf56zBhnTKpvrmxiQrAmyzL2m1vMVWONgp6iisugEc,4521
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/CODE_OF_CONDUCT.md,sha256=YxbJvW-YZG7FnC4eavwO7_eJMDv76uRa3Iy-EapQ6qc,8493
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/CONTRIBUTING.md,sha256=-VjhxyduKnRHjhyrIvrDC5AA36XstHXxcYVZNTAHelU,3871
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/HISTORY.md,sha256=PYeH6H2uaeYfSTReCx4LkKnb5OtB581MSulS2f1LO5I,93
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/LICENSE,sha256=CUybc5eSu0epdA3N-tWsJ3bBQ1T-_mEmsuYCSmGGxKY,1105
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/MANIFEST.in,sha256=CgQfcEPusonTMMu1S_2fFbqg73XtEZbdOINPjeSpJLA,221
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/README.md,sha256=n7biltzuUt9mPrh-pS2tCqfsLjhfZ6SHgnvqev2K_fA,810
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/justfile,sha256=Fj5MBzZnXel5Roq8s_aSOsZZRhJmQV01U8bUGdwvzRY,2531
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/pyproject.toml,sha256=rwZXnSCLZNAkrKTqCfeTN7u25HHVu4H6ZN5rbq9tsok,1609
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/.github/ISSUE_TEMPLATE.md,sha256=uh2KIB8YW7Jl1DTXEp4irIkCQkSg1w0czvqVHILBQ7U,342
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/.github/workflows/publish.yml,sha256=4WayUsd1YiSYPplicKVxQUB8l-qSVm5dgXsyi4Wvo2U,327
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/.github/workflows/test.yml,sha256=EdZomjwk0hPpuoiOaQlVAdBAnV5mwWABoj0kcxoK4WA,1108
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/docs/index.md,sha256=RhtW6tFgRGt59VIw5NmIuWydZzqirkUtRYUVdOAHuNk,324
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/docs/installation.md,sha256=CAPcmUD-_o3iMSR9d11y0uUm7JHP3oHxBjZPa6KK-zc,983
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/docs/usage.md,sha256=4mEwuA0Wby0otc7MTLxVf2d7pnZl459h5DgL8zkfL3E,116
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/src/{{cookiecutter.project_slug}}/__init__.py,sha256=SB94Bs6t5mGZXEcTw-wy-PJSs6LAJ05tVqG-MhaK-TM,149
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/src/{{cookiecutter.project_slug}}/__main__.py,sha256=Qd-f8z2Q2vpiEP2x6PBFsJrpACWDVxFKQk820MhFmHo,59
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/src/{{cookiecutter.project_slug}}/cli.py,sha256=OIII0xxFg2XUKG7QSB7CL180sfwkVqebvoOy7zIwEgk,554
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/src/{{cookiecutter.project_slug}}/utils.py,sha256=1RxiNQM7rpegUEPuFvOlbSGesR4gnWpXr82bZQCgELM,77
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/src/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}.py,sha256=h0hwdogXGFqerm-5ZPeT-irPn91pCcQRjiHThXsRzEk,19
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/tests/__init__.py,sha256=iAzxVEdL8bFF_-yRdlf_xgKhB0y9XCNPvwe0qmxa8_k,61
+cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/tests/test_{{cookiecutter.project_slug}}.py,sha256=BTNSRWuf_1boZhu6tZsEh3ka1yQaXuqMLXNFE_2Tetc,631
+cookiecutter_pypackage-0.3.0.dist-info/METADATA,sha256=M6eslNoiPoOyIbXVBNYV_hpIov7eYLqWciQTwBXQ_uQ,3559
+cookiecutter_pypackage-0.3.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+cookiecutter_pypackage-0.3.0.dist-info/entry_points.txt,sha256=PNqgcmBDp6Uphq0pjh6nkh0yZQJJe27nB3UIEaL-09I,74
+cookiecutter_pypackage-0.3.0.dist-info/licenses/LICENSE,sha256=WW7yb6Jur8QGwqGTihAsf_jSAvVMCfyV2sulBep2xS4,1079
+cookiecutter_pypackage-0.3.0.dist-info/RECORD,,

{cookiecutter_pypackage-0.2.0.dist-info → cookiecutter_pypackage-0.3.0.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any
-

cookiecutter_pypackage-0.3.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+cookiecutter-pypackage = cookiecutter_pypackage.cli:app

cookiecutter_pypackage-0.3.0.dist-info/licenses/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.2.0.dist-info/METADATA

@@ -1,33 +0,0 @@
-Metadata-Version: 2.4
-Name: cookiecutter-pypackage
-Version: 0.2.0
-Summary: Cookiecutter template for a Python package
-Author-email: "Audrey M. Roy Greenfeld" <audrey@feldroy.com>
-License: BSD
-Project-URL: homepage, https://github.com/audreyfeldroy/cookiecutter-pypackage
-Keywords: cookiecutter,template,package
-Classifier: Development Status :: 4 - Beta
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Developers
-Classifier: Natural Language :: English
-Classifier: License :: OSI Approved :: BSD License
-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 :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-Classifier: Topic :: Software Development
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: cookiecutter>=2.6.0
-Requires-Dist: ruff>=0.12.4
-Requires-Dist: pytest>=8.4.1
-Requires-Dist: pytest-cookies>=0.7.0
-Requires-Dist: typer>=0.16.0
-Requires-Dist: nox>=2025.5.1
-Requires-Dist: alabaster>=1.0.0
-Requires-Dist: watchdog>=6.0.0
-Dynamic: license-file

cookiecutter_pypackage-0.2.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-cookiecutter_pypackage-0.2.0.dist-info/licenses/LICENSE,sha256=GPb7Bicu3qGhPElEp2FzlTgIvdrDoeBaFYdpJ470FdY,1551
-hooks/post_gen_project.py,sha256=PF6fIWYiIdgzxtnw94H2tCrKG0qpUeEfGyCTDHrU0HM,332
-hooks/pre_gen_project.py,sha256=SlT833xxMsc1oX0IxUfREgsVsnSbM5VgjOqKiaRUJIg,347
-cookiecutter_pypackage-0.2.0.dist-info/METADATA,sha256=ceVKFBw2cpkr56Ucp6abj2UZaD9uI3Bxov6XsdIIl4E,1309
-cookiecutter_pypackage-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-cookiecutter_pypackage-0.2.0.dist-info/top_level.txt,sha256=I0gcmmeA3xdjjkokY-bVx5WycqQcFVAk4RHQB-wl9h8,6
-cookiecutter_pypackage-0.2.0.dist-info/RECORD,,

cookiecutter_pypackage-0.2.0.dist-info/licenses/LICENSE

@@ -1,27 +0,0 @@
-Copyright (c) Audrey Roy Greenfeld and individual contributors.
-
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
-
-    * Redistributions of source code must retain the above copyright notice,
-      this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright notice,
-      this list of conditions and the following disclaimer in the documentation
-      and/or other materials provided with the distribution.
-    * Neither the name of Audrey Roy Greenfeld nor the names of its contributors
-      may be used to endorse or promote products derived from this software
-      without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
-CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

cookiecutter_pypackage-0.2.0.dist-info/top_level.txt

@@ -1 +0,0 @@
-hooks

hooks/post_gen_project.py

@@ -1,12 +0,0 @@
-#!/usr/bin/env python
-import pathlib
-
-
-if __name__ == '__main__':
-
-    if '{{ cookiecutter.create_author_file }}' != 'y':
-        pathlib.Path('AUTHORS.rst').unlink()
-        pathlib.Path('docs', 'authors.rst').unlink()
-
-    if 'Not open source' == '{{ cookiecutter.open_source_license }}':
-        pathlib.Path('LICENSE').unlink()

hooks/pre_gen_project.py

@@ -1,13 +0,0 @@
-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)