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

{cookiecutter_pypackage-0.3.0 → cookiecutter_pypackage-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cookiecutter-pypackage
-Version: 0.3.0
+Version: 0.3.1
 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>
@@ -47,31 +47,52 @@ Description-Content-Type: text/markdown
 
 ## 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
+*   Modern tooling: [uv](https://docs.astral.sh/uv/) for dependency management, [justfile](https://github.com/casey/just) for task running
+*   Testing with pytest, GitHub Actions for Python 3.10, 3.11, 3.12, 3.13, and 3.14
+*   Auto-release to [PyPI](https://pypi.python.org/pypi) via Trusted Publishers when you push a tag
+*   Command line interface using [Typer](https://typer.tiangolo.com/)
 
 ## Quickstart
 
-Install the latest Cookiecutter if you haven't installed it yet:
+First, install [uv](https://docs.astral.sh/uv/getting-started/installation/) if you haven't already.
+
+Generate a new Python package:
 
 ```bash
-pip install -U cookiecutter
+uvx cookiecutter-pypackage
+```
+
+You'll be prompted for some values:
+
+```
+[1/9] full_name (Audrey M. Roy Greenfeld): Your Name
+[2/9] email (audreyfeldroy@example.com): you@example.com
+[3/9] github_username (audreyfeldroy): your-github-username
+[4/9] pypi_package_name (python-boilerplate): my-package
+[5/9] project_name (Python Boilerplate): My Package
+[6/9] project_slug (my_package):
+[7/9] project_short_description (...): A short description of your package.
+[8/9] pypi_username (your-github-username):
+[9/9] first_version (0.1.0):
 ```
 
-Generate a Python package project:
+<details>
+<summary>Traditional way (without uvx)</summary>
 
 ```bash
-cookiecutter https://github.com/audreyfeldroy/cookiecutter-pypackage.git
+uv venv
+source .venv/bin/activate
+uv pip install cookiecutter
+cookiecutter gh:audreyfeldroy/cookiecutter-pypackage
 ```
 
+</details>
+
 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.
+*   Create a GitHub repo and push your code
+*   Set up [PyPI Trusted Publishing](https://docs.pypi.org/trusted-publishers/) for your repo
+*   Release your package by pushing a tag: `git tag v0.1.0 && git push --tags`
 
 ## Not Exactly What You Want?
 

cookiecutter_pypackage-0.3.1/README.md

@@ -0,0 +1,78 @@
+# 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
+
+*   Modern tooling: [uv](https://docs.astral.sh/uv/) for dependency management, [justfile](https://github.com/casey/just) for task running
+*   Testing with pytest, GitHub Actions for Python 3.10, 3.11, 3.12, 3.13, and 3.14
+*   Auto-release to [PyPI](https://pypi.python.org/pypi) via Trusted Publishers when you push a tag
+*   Command line interface using [Typer](https://typer.tiangolo.com/)
+
+## Quickstart
+
+First, install [uv](https://docs.astral.sh/uv/getting-started/installation/) if you haven't already.
+
+Generate a new Python package:
+
+```bash
+uvx cookiecutter-pypackage
+```
+
+You'll be prompted for some values:
+
+```
+[1/9] full_name (Audrey M. Roy Greenfeld): Your Name
+[2/9] email (audreyfeldroy@example.com): you@example.com
+[3/9] github_username (audreyfeldroy): your-github-username
+[4/9] pypi_package_name (python-boilerplate): my-package
+[5/9] project_name (Python Boilerplate): My Package
+[6/9] project_slug (my_package):
+[7/9] project_short_description (...): A short description of your package.
+[8/9] pypi_username (your-github-username):
+[9/9] first_version (0.1.0):
+```
+
+<details>
+<summary>Traditional way (without uvx)</summary>
+
+```bash
+uv venv
+source .venv/bin/activate
+uv pip install cookiecutter
+cookiecutter gh:audreyfeldroy/cookiecutter-pypackage
+```
+
+</details>
+
+Then:
+
+*   Create a GitHub repo and push your code
+*   Set up [PyPI Trusted Publishing](https://docs.pypi.org/trusted-publishers/) for your repo
+*   Release your package by pushing a tag: `git tag v0.1.0 && git push --tags`
+
+## 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_pypackage-0.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "cookiecutter-pypackage"
-version = "0.3.0"
+version = "0.3.1"
 description = "Cookiecutter template for a Python package"
 readme = "README.md"
 requires-python = ">=3.10"

{cookiecutter_pypackage-0.3.0 → cookiecutter_pypackage-0.3.1}/src/cookiecutter_pypackage/__init__.py

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

cookiecutter_pypackage-0.3.0/README.md

@@ -1,57 +0,0 @@
-# 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.