python3-cookiecutter

Author: Jared Cook
Version: 0.1.0

Overview

Python3 cookiecutter template project + Github docs template generation + Sphinx docs template generation.

Utilizes:
The python3-cookiecutter depends on the following repositories for its documentation and sub-features.

• cookiecutter-cookiecutter is the the parent repository for python3-cookiecutter. Updates from cookiecutter_project_upgrader are pulled from this repository.
• Github docs cookiecutter template generation for Github Pages (Jekyll).
• Sphinx docs cookiecutter template generation for Python Sphinx Documentation.
• Nutri-Matic cookiecutter utilities for streamlining development and utilization of Cookiecutter templates.

Maintains:
The python3-cookiecutter is used to maintain the build and ci/cd structure for the following projects.

• Nutri-Matic cookiecutter utilities for streamlining development and utilization of Cookiecutter templates.

---

🛠️ CI/CD Check List:

• 
• 
• 
• 
• 
• 
• 

---

Note: Unless you are using a newer version of cookiecutter >= 2, --no-input is necessary for template generation without error.

Usage Examples

Example: Pull from main branch.
Note: Nutri-Matic is needed in active python environment.

1. Pull Project with cookiecutter command:

$ cookiecutter git@github.com:jcook3701/python3-cookiecutter.git \
	--no-input \
	project_name="test-project"  

Example: Pull from develop branch.

1. Pull code from development branch while testing updates.

$ cookiecutter git@github.com:jcook3701/python3-cookiecutter.git \
	  --checkout develop \
	  --no-input \
	  project_name="test-project"

replace test-project or any of the other variables with real context configuration variables:

Note: replace test-project or any of the other variables with real context configuration variables.

---

🌱 Getting Started

• Requirements
• Installation guide

📚 Documentation

The python3-cookiecutter documentation is available at docs.

🤝 Contributing

If you’re interested in contributing to the python3-cookiecutter project:

• Start by reading the contributing guide.
• Learn how to setup your local environment, in our developer guide.
• Look through our style guide.

---

🍹 Authors Notes

1. This code currently works with cookiecutter (V2.6) from PyPi’s repositories.

⚖️ License

Copyright (c) 2025-2026, Jared Cook

This project is licensed under the AGPL-3.0-or-later License.
See the LICENSE file for the full license text.

SPDX-License-Identifier: AGPL-3.0-or-later

---