Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 1.52 KB

README.md

File metadata and controls

52 lines (36 loc) · 1.52 KB
Raw

Cookiecutter Templates

A collection of cookiecutter templates for use in MobileCoinFoundation repositories.

Each subdirectory contains a cookiecutter template. See individual README files for more details on what each one does.

Usage

Invoking cookiecutter with this repository requires the use of the --directory option.

For example to use the rust-workspace template.

cookiecutter gh:mobilecoinfoundation/cookiecutters --directory rust-workspace

Installing cookiecutter

To install cookiecutter consider using something like pipx.

The advantage to using pipx is that cookiecutter will be installed in an isolated python environment.

Note: The following suggested install is isolated to the current user. This means the use sudo is not needed, or recommended. Using sudo with these specific commands will almost certainly cause issues.

Install pipx:

python3 -m pip install --user pipx
python3 -m pipx ensurepath

Restart your terminal

Install cookiecutter:

pipx install cookiecutter

There is alternate installation instructions provided by the cookiecutter docs, https://cookiecutter.readthedocs.io/en/stable/installation.html, however this results in pulling cookiecutter dependencies into the system or user python environment.