CATMAID-ext-cookiecutter

This is a cookiecutter template for CATMAID extensions.

It builds most of the necessary boilerplate, including but not limited to:

• setup.py for installing the extension with pip
• .travis.yml for running tests against CATMAID
• An API endpoint for checking whether the extension is installed
• A unit test for hitting that endpoint
• An empty frontend widget

It assumes you are using the same (recommended) tool stack as CATMAID: github, travis-ci, and coveralls.

Usage

For more details, see the cookiecutter repo and docs

tl;dr

• Install cookiecutter : pip install --user cookiecutter
• Use cookiecutter to fetch and use this template: cookiecutter gh:clbarnes/CATMAID-ext-cookiecutter

Contributing

This is unlikely to be actively maintained as CATMAID changes (e.g. directory reorganisation, travis build steps, widget conventions), but pull requests to update it are welcome!

Fork and clone the CATMAID-myextension repo into the examples/ directory. Make your changes to CATMAID-ext-cookiecutter and then run examples/regenerate.sh to write your template's output into that repo and make a commit. The commit message will contain the CATMAID-ext-cookiecutter's current hash and working directory diff.