Contributing

Dependencies

This project uses Poetry to manage dependencies, virtual environments, builds, and packaging. Install it by following the instructions here.

Environment

Setup:

1. Clone the repo:

   $ git clone https://github.com/PrincetonCS-UCA/codepost-powertools.git
   $ cd codepost-powertools
   

2. Create/update the virtual environment with Poetry:

   $ poetry install --with dev
   

   If editing the docs, be sure to include the optional docs group:

   $ poetry install --with dev,docs
   

To run the Powertools CLI, use the following command:

$ poetry run cptools ...

Remember to prefix poetry run for any commands that require the virtual environment.

Alternatively, start the Poetry shell:

$ poetry shell
(codepost-powertools-py3.X) $ cptools ...
(codepost-powertools-py3.X) $ pytest ...