https://github.com/midnighter/cookiecutter-python-package
A complete Python package cookiecutter template with lots of bells and whistles.
https://github.com/midnighter/cookiecutter-python-package
cookiecutter python
Last synced: about 1 year ago
JSON representation
A complete Python package cookiecutter template with lots of bells and whistles.
- Host: GitHub
- URL: https://github.com/midnighter/cookiecutter-python-package
- Owner: Midnighter
- License: apache-2.0
- Created: 2023-01-17T09:57:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-30T20:33:52.000Z (about 1 year ago)
- Last Synced: 2025-05-13T01:14:47.973Z (about 1 year ago)
- Topics: cookiecutter, python
- Language: Python
- Homepage:
- Size: 129 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
# Cookiecutter Template for Python Packages
_Initialize a complete Python package project structure._
## Usage
### Dependencies
Create or activate a Python virtual environment. You can [read this guide to
learn more](https://realpython.com/python-virtual-environments-a-primer/) about
them and how to create one. Alternatively, particularly if you are a Windows or
Mac user, you can also use [Anaconda](https://docs.anaconda.com/anaconda/).
After creating a virtual environment, install
[cruft](https://cruft.github.io/cruft/) to create your project from this
template. Cruft also helps you to later [manage
updates](https://cruft.github.io/cruft/#updating-a-project) to the template. If
you are using a conda environment, please use `conda` instead of `pip`.
```shell
pip install cruft jinja2-strcase jinja2-time
```
### Create
Now you are ready to create your project by answering the template questions
that follow.
```shell
cruft create https://github.com/Midnighter/cookiecutter-python-package
```
The cookiecutter project itself is provided under the [Apache Software License
2.0](https://www.apache.org/licenses/LICENSE-2.0), however, you can freely
choose the license for your generated project. MIT, BSD-3-Clause, Apache-2.0, and
proprietary code are supported out of the box, but you can replace this with
whatever license you wish, of course.
### Update
If, at a later point, you want to update your project with changes added to this
cookiecutter template, you can do so with one command from the root of your
project directory:
```shell
cruft update
```
You will get a chance to review the changes to be merged into your existing
project.
## Copyright
* Copyright © 2022-2024, Moritz E. Beber
* Copyright © 2019-2022, openCOBRA
* Free software distributed under the [Apache Software License
2.0](https://www.apache.org/licenses/LICENSE-2.0)