README.md

{{cookiecutter.project_name}}

Usage

1. cd into project directory.

2. Create a virtual environment.

$ make venv

3. Activate it.

$ source venv/bin/activate

4. Install development dependencies with editable mode to test the CLI.

$ make install

Take your CLI for a spin

This Cookiecutter comes with two generic CLI commands, namely, init and hello.

$ {{cookiecutter.cli_command.strip().lower().replace(' ', '_').replace('-', '_')}} init

$ {{cookiecutter.cli_command.strip().lower().replace(' ', '_').replace('-', '_')}} show

Test with Docker

CLI commands can be tested with Docker.

1. Build an image for the CLI.

   Image is tagged with the same name as the cli_command.

$ make docker-image

2. Run the command inside the container.

$ docker-run --rm {{cookiecutter.cli_command.strip().lower().replace(' ', '_').replace('-', '_')}} init

Documentation

1. Install documentation-related dependencies.

$ make docs

2. Serve the docs locally.

$ make serve-docs

Distribution

NOTE

Make sure you have account in PyPI before you try this out.

To publish you CLI to PyPI, run:

$ make distributions

dist directory will be created inside your project directory. Upload it to PyPI using:

$ twine dist/*

Help

For help related to make commands.

$ make help