Quico/py-cookiecutter-templates
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Compare commits

base: Quico:33bf729b009859cb1d9e3583ad2b7ce2b31c6aa4
Branches Tags
Quico:master
..
compare: Quico:8b2c0ceccad7d97fb2217b892f582e5b04e43d72
Branches Tags
Quico:master

No commits in common. "33bf729b009859cb1d9e3583ad2b7ce2b31c6aa4" and "8b2c0ceccad7d97fb2217b892f582e5b04e43d72" have entirely different histories.
33bf729b00 ... 8b2c0cecca

2 changed files with 6 additions and 15 deletions
Show Stats Expand all files Collapse all files

5
.vscode/settings.json vendored
View File

@ -1,5 +0,0 @@
{
"conventionalCommits.scopes": [
"meta"
]
}

16
README.md
View File

@ -1,16 +1,12 @@
# py-cookiecutter-templates
Project directory structure templates for the Python Cookiecutter package.
Project directory structure templates for the Python Cookiecutter module.
## What's Cookiecutter?
The Python package [Cookiecutter](https://github.com/cookiecutter/cookiecutter) assists in creating directory structure for whatever purpose you need such as for example a new Python project, an Ansible role or a `docker-compose` project - anything really that benefits from a unifirm reproducible directory structure. If you've ever wanted to put project structure best practices into version control then Cookiecutter's here to help.
The Python package [Cookiecutter](https://github.com/cookiecutter/cookiecutter) assists in creating directory structure for whatever purpose you need such as for example a new Python project, an Ansible role or a `docker-compose` project. If you've ever wanted to put project structure best practices into version control Cookiecutter's here to help.
Cookiecutter is governed by so-called Cookiecutter templates, most of its magic inside Cookiecutter templates happens via the [Jinja2 template engine](https://palletsprojects.com/p/jinja/). You'll feel right at home if you're familiar with Ansible.
## Repo layout
Each subdirectory in this repo is a Cookiecutter template, you'll recognize them from their telltale `cookiecutter.json` files. Directories usually also have a readme file explaining more about each individual template.
Cookiecutter is governed by so-called Cookiecutter templates. Most of its magic inside Cookiecutter templates happens via the [Jinja2 template engine](https://palletsprojects.com/p/jinja/) so if you're familiar with Ansible you'll feel right at home.
## Get started
@ -28,9 +24,7 @@ Cookiecutter prompts you for whatever info the template needs then generates fil
This is Cookiecutter prompting for info:
```
service []: grafana
component_list [grafana]: grafana,nginx
context []: cncf
info
```
The end result is a directory structure that has everything you need to hit the ground running.
@ -56,3 +50,5 @@ The end result is a directory structure that has everything you need to hit the
└── env
└── fully.qualified.domain.name.example
```
Each subdirectory in this repo is a Cookiecutter template, you'll recognize them from their telltale `cookiecutter.json` files. Directories usually have a readme file explaining a bit more about each individual template.