https://github.com/btr1975/cookiecutter-python-library
python cookiecutter template
https://github.com/btr1975/cookiecutter-python-library
batch cookiecutter docker make podman python template-project
Last synced: 10 months ago
JSON representation
python cookiecutter template
- Host: GitHub
- URL: https://github.com/btr1975/cookiecutter-python-library
- Owner: btr1975
- License: mit
- Created: 2022-06-25T01:27:30.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-22T18:43:36.000Z (10 months ago)
- Last Synced: 2025-03-22T19:22:06.845Z (10 months ago)
- Topics: batch, cookiecutter, docker, make, podman, python, template-project
- Language: Python
- Homepage:
- Size: 75.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cookiecutter-python-library
| BRANCH | STATUS |
| ------ |--------|
| main | [](https://github.com/btr1975/cookiecutter-python-library/actions/workflows/test-bake.yml) |
| develop | [](https://github.com/btr1975/cookiecutter-python-library/actions/workflows/test-bake.yml) |
* This is a "cookiecutter" repository designed to be used as a framework to create repository structure.
## How to use a "cookiecutter" repository
1. First install the python library called [cookiecutter](https://cookiecutter.readthedocs.io/en/stable/)
```text
pip install cookiecutter
```
2. Create a **TOTALLY** empty repository in a GIT based system. In my example I am creating a repo called
throw-me-away.
3. Use the cookiecutter repository to create your structure.
* Use the latest
##### HTTPS
```text
cookiecutter https://github.com/btr1975/cookiecutter-python-library
```
##### SSH
```text
cookiecutter git@github.com:btr1975/cookiecutter-python-library
```
* Use a specific version
##### HTTPS
```text
cookiecutter https://github.com/btr1975/cookiecutter-python-library -c 1.0.0
```
##### SSH
```text
cookiecutter git@github.com:btr1975/cookiecutter-python-library -c 1.0.0
```
4. Now you will be asked a series of questions. This is an example
**THE QUESTIONS MAY NOT BE THE EXACT FOR THIS COOKIECUTTER**, also if you have downloaded it before
you will be asked if you want to download it again, always say yes to get the latest version.
```text
full_name [Your Full Name]: Ben T
email [Your E-Mail Address]: somename@example.com
git_username [Your GitHub Username]: btr1975
git_repo_name [The Repository Name]: throw-me-away
git_url [The GIT URL]: https://github.com/btr1975/throw-me-away
app_description [A short description]: This is great
app_version [0.1.0]:
```
5. Now initialize it and push it up to the GIT based system.
```text
git init -b main
git add --all
git commit -m "First"
git remote add origin https://github.com/btr1975/throw-me-away.git
git push -u origin main
```