cli-todo-jd 0.1.0

Add your description here

cli-todo-jd

A command line to do list with interactive menu

Getting started

To start using this project, first make sure your system meets its requirements.

It's suggested that you install this package and its requirements within a virtual environment.

Requirements

• Python 3.9+ installed

Installing the package

Whilst in the root folder, in a terminal, you can install the package and its Python dependencies using:

python -m pip install -U pip setuptools
pip install -e .

Install for contributors/developers

To install the contributing requirements, use:

python -m pip install -U pip setuptools
pip install -e .[dev]
pre-commit install

This installs an editable version of the package. This means that when you update the package code you do not have to reinstall it for the changes to take effect. This saves a lot of time when you test your code.

Remember to update the setup and requirement files inline with any changes to your package.

Licence

Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.

Contributing

If you want to help us build and improve {{ cookiecutter.project_slug }}, please take a look at our contributing guidelines.

Acknowledgements

This project structure is based on the govcookiecutter template project.