lrkissling / cookiecutter-falcon Goto Github PK

Cookiecutter is a command-line utility that creates projects from cookiecutters (project templates), e.g. creating a Python package project from a Python package project template. In this page we are going to show how to create new falcon projects.

Install cookiecutter It's simple, you only need to install python package:

pip install cookiecutter

Now you can create new projects using your favourite template.

Create a falcon skeleton project To do it you need to clone the git repository:

git clone https://github.com/7ideas/cookiecutter-falcon.git

To create the skel you need to indicate to cookiecutter where the template is:

cd cookiecutter-falcon
cookiecutter .

The tool is interactive and it will request for some information as:

• project_name
• project_slug
• author_name
• author_mail
• project_description [A short description of the project.]
• project_url [example.com]
• use_docker
• use_mongodb
• use_redisdb
• Select open_source_license or not open source

When finished, a folder in the current directory with the name of selected "project_name" step given is created. You only need to move it where you want it lives:

cd my_project
tree .
.
├── my_project
│   ├── app.py
│   ├── __init__.py
│   ├── sample
│   │   ├── __init__.py
│   │   └── models.py
│   └── settings
│       ├── base.py
│       ├── docker.py
│       ├── __init__.py
│       ├── local.py
│       └── production.py
├── docker
│   ├── falcon-docker-entrypoint.sh
│   └── FalconDockerfile
├── docker-compose.yml
├── README.rst
├── requirements
│   ├── dev-requirements.txt
│   ├── requirements.txt
│   └── test-requirements.txt
├── setup.py
└── tox.ini
 
5 directories, 18 files