-
Notifications
You must be signed in to change notification settings - Fork 1
Home
A Python archetype to help me and others begin developing a coding project. The archetype follows a customizable project structure using cookiecutter as a template generator.
A command-line utility that creates projects from cookiecutters (project templates), e.g. creating a Python package project from a Python package project template.
Visit these links to learn more about cookiecutter. Documentation: https://cookiecutter.readthedocs.io/ GitHub: https://github.com/cookiecutter/cookiecutter
Installing cookiecutter package on Ubuntu is very easy, visit the link to the cookiecutter documentation to learn how to install it. Install cookiecutter
To generate a custom project from the template, follow these steps:
-
- Navigate to the path where you desire to generate the project folder.
-
- Run the cookiecutter command followed by the repository URL.
cookiecutter https://github.com/charlstown/py-template.git -
- Fill out the form in the console and the project will be generated at the end.
Explain all the steps to execute your app. Remember if it's for Linux/mac or windows or both, and help yourself with coding snippets to explain the commands.
# Example of a code snippet
python code/myapp.py -MyFlags
Errors, future updates, or beta configurations. Explain why and how it could break.
Explain the dos and don'ts of your app, what you take responsibility for, and where is the limit of its purpose.
Some extra help or clarification about the whole process. What you don't provide.
References, contact, or related repositories go here.