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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,3 +1,3 @@
1
1
  """Cookiecutter PyPackage - A modern Python package template."""
2
2
 
3
- __version__ = "0.3.0"
3
+ __version__ = "0.3.1"
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: cookiecutter-pypackage
3
- Version: 0.3.0
3
+ Version: 0.3.1
4
4
  Summary: Cookiecutter template for a Python package
5
5
  Project-URL: homepage, https://github.com/audreyfeldroy/cookiecutter-pypackage
6
6
  Author-email: "Audrey M. Roy Greenfeld" <audrey@feldroy.com>
@@ -47,31 +47,52 @@ Description-Content-Type: text/markdown
47
47
 
48
48
  ## Features
49
49
 
50
- * Testing setup with pytest
51
- * GitHub Actions testing: Setup to easily test for Python 3.10, 3.11, 3.12, and 3.13
52
- * Auto-release to [PyPI](https://pypi.python.org/pypi) when you push a new tag to main (optional)
53
- * Command line interface using Typer
50
+ * Modern tooling: [uv](https://docs.astral.sh/uv/) for dependency management, [justfile](https://github.com/casey/just) for task running
51
+ * Testing with pytest, GitHub Actions for Python 3.10, 3.11, 3.12, 3.13, and 3.14
52
+ * Auto-release to [PyPI](https://pypi.python.org/pypi) via Trusted Publishers when you push a tag
53
+ * Command line interface using [Typer](https://typer.tiangolo.com/)
54
54
 
55
55
  ## Quickstart
56
56
 
57
- Install the latest Cookiecutter if you haven't installed it yet:
57
+ First, install [uv](https://docs.astral.sh/uv/getting-started/installation/) if you haven't already.
58
+
59
+ Generate a new Python package:
58
60
 
59
61
  ```bash
60
- pip install -U cookiecutter
62
+ uvx cookiecutter-pypackage
63
+ ```
64
+
65
+ You'll be prompted for some values:
66
+
67
+ ```
68
+ [1/9] full_name (Audrey M. Roy Greenfeld): Your Name
69
+ [2/9] email (audreyfeldroy@example.com): you@example.com
70
+ [3/9] github_username (audreyfeldroy): your-github-username
71
+ [4/9] pypi_package_name (python-boilerplate): my-package
72
+ [5/9] project_name (Python Boilerplate): My Package
73
+ [6/9] project_slug (my_package):
74
+ [7/9] project_short_description (...): A short description of your package.
75
+ [8/9] pypi_username (your-github-username):
76
+ [9/9] first_version (0.1.0):
61
77
  ```
62
78
 
63
- Generate a Python package project:
79
+ <details>
80
+ <summary>Traditional way (without uvx)</summary>
64
81
 
65
82
  ```bash
66
- cookiecutter https://github.com/audreyfeldroy/cookiecutter-pypackage.git
83
+ uv venv
84
+ source .venv/bin/activate
85
+ uv pip install cookiecutter
86
+ cookiecutter gh:audreyfeldroy/cookiecutter-pypackage
67
87
  ```
68
88
 
89
+ </details>
90
+
69
91
  Then:
70
92
 
71
- * Create a repo and put it there.
72
- * [Register](https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives) your project with PyPI.
73
- * Add the repo to your [Read the Docs](https://readthedocs.io/) account + turn on the Read the Docs service hook.
74
- * Release your package by pushing a new tag to main.
93
+ * Create a GitHub repo and push your code
94
+ * Set up [PyPI Trusted Publishing](https://docs.pypi.org/trusted-publishers/) for your repo
95
+ * Release your package by pushing a tag: `git tag v0.1.0 && git push --tags`
75
96
 
76
97
  ## Not Exactly What You Want?
77
98
 
@@ -1,4 +1,4 @@
1
- cookiecutter_pypackage/__init__.py,sha256=wsBDAjiroEMi6F3b3GmCu2jSywyuF1SqYvwCagCoQQM,88
1
+ cookiecutter_pypackage/__init__.py,sha256=WDed3GQsdiAT_RjTKIkCxvs2D4x6wL5Wv8h1n43Hedc,88
2
2
  cookiecutter_pypackage/cli.py,sha256=P5-1gkljvw0y5UyuU5a1Kb08LyIn3N0Ttr9VMqYOEiw,1110
3
3
  cookiecutter_pypackage/template/cookiecutter.json,sha256=vwW0v8LRT61tu4rN_Ci6VRjD9992qaYayG2jLaQ9_OA,573
4
4
  cookiecutter_pypackage/template/hooks/post_gen_project.py,sha256=AS4vyATxgPwT4D8svzUTpApYcuBz_abnmu6b9b5zdCA,122
@@ -26,8 +26,8 @@ cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/src/{{cookiec
26
26
  cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/src/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}.py,sha256=h0hwdogXGFqerm-5ZPeT-irPn91pCcQRjiHThXsRzEk,19
27
27
  cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/tests/__init__.py,sha256=iAzxVEdL8bFF_-yRdlf_xgKhB0y9XCNPvwe0qmxa8_k,61
28
28
  cookiecutter_pypackage/template/{{cookiecutter.pypi_package_name}}/tests/test_{{cookiecutter.project_slug}}.py,sha256=BTNSRWuf_1boZhu6tZsEh3ka1yQaXuqMLXNFE_2Tetc,631
29
- cookiecutter_pypackage-0.3.0.dist-info/METADATA,sha256=M6eslNoiPoOyIbXVBNYV_hpIov7eYLqWciQTwBXQ_uQ,3559
30
- cookiecutter_pypackage-0.3.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
31
- cookiecutter_pypackage-0.3.0.dist-info/entry_points.txt,sha256=PNqgcmBDp6Uphq0pjh6nkh0yZQJJe27nB3UIEaL-09I,74
32
- cookiecutter_pypackage-0.3.0.dist-info/licenses/LICENSE,sha256=WW7yb6Jur8QGwqGTihAsf_jSAvVMCfyV2sulBep2xS4,1079
33
- cookiecutter_pypackage-0.3.0.dist-info/RECORD,,
29
+ cookiecutter_pypackage-0.3.1.dist-info/METADATA,sha256=rXXitCppD8EGHjJBJYDV0F5IJlZdxgmF6_ZsxGi7zf8,4223
30
+ cookiecutter_pypackage-0.3.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
31
+ cookiecutter_pypackage-0.3.1.dist-info/entry_points.txt,sha256=PNqgcmBDp6Uphq0pjh6nkh0yZQJJe27nB3UIEaL-09I,74
32
+ cookiecutter_pypackage-0.3.1.dist-info/licenses/LICENSE,sha256=WW7yb6Jur8QGwqGTihAsf_jSAvVMCfyV2sulBep2xS4,1079
33
+ cookiecutter_pypackage-0.3.1.dist-info/RECORD,,