bnb-cookiecutter-example

A project.

See the full documentation at https://bnb-cookiecutter-example.readthedocs.io

Installation

This project is currently only installable via development tooling.

• Install poetry
• $ git clone https://github.com/bnbalsamo/bnb-cookiecutter-example.git
• $ cd bnb-cookiecutter-example
• $ poetry install --no-dev

Development

To install + configure a development environment...

• Install poetry
• Clone the repository
  • git clone git@github.com:bnbalsamo/bnb-cookiecutter-example.git
• cd into the project directory
  • cd bnb-cookiecutter-example
• Install the project and development dependencies with poetry
  • poetry install -E docs -E tests
• Activate the project's virtual environment in your current shell
  • poetry shell
• Install the pre-commit hooks
  • pre-commit install --install-hooks

Development tasks are available via the tasks.py invoke script. After installation you can view the help via inv --list

Running Tests

$ inv test

Running autoformatters

$ inv format

Upgrading Dependencies

$ poetry update

Author

First Last you@provider.com

Created using bnbalsamo/cookiecutter-pypackage v0.48.0