Skip to content

Project development workflow

Cloning the repository

Run poe setup in new repository clones to enable git hooks:

git clone https://github.com/<github_user>/<project_name>
cd project_name
poe setup  # Enables git hooks

Development tools

  • poe lint: Run formatters and static checks
  • poe test: Run tests

The lint and test tasks can also be run as a single combined command with:

poe lt

Documentation server

Start the development server with:

poe docs

The documentation site will be served at http://localhost:8000.

To use a different bind host/port, run poe --help docs for arguments info.