cookiecutter-ffrd-template

Cookiecutter template for generating a new toolkit repository.

Features

• MIT License
• Dev Container support
• A functioning testing template as guidance
• Other version control best practices built-in

Requirements to use the cookiecutter template:

---

• Python 2.7 or 3.5+
• Cookiecutter Python package >= 1.4.0: This can be installed with pip by or conda depending on how you manage your Python packages:

Pip:

$ pip install cookiecutter

Conda [or micromamba]:

$ conda [micromamba] install -c conda-forge cookiecutter

To start a new project:

---

$ cookiecutter https://github.com/fema-ffrd/cookiecutter-ffrd-template

1. Generate a new project template using the command line argument  
2. Initialize this new directory as a git repository  
3. Connect the local repository to a new remote repository  
4. See .devcontainer/README.md for instructions on setting your python environment