development.md

Development

This project uses a Nix shell to provide a development environment. To develop on this plugin, please ensure first that you have installed the Nix package manager, ideally, or that you have all the dependencies you'll need otherwise installed (e.g., in a virtual environment you're managing separately). If you're using the Nix shell, the first time it's started it will create a .venv subfolder in the project root folder.

By default, with nix-shell, you should have all the dependencies you'll need not only to use this plugin, but also to develop on it. In other words, dependencies to do things like run tests, run linter(s), and run type checking should all be provided. If you try and that's not the case, please check the Issue Tracker. If an issue's open for what you're experiencing, please upvote the initial description of the issue and/or comment on the ticket.

Testing, formatting, and linting

Here's what corresponds approximately to what's run for CI through the project's GitHub actions workflows.

NB: Each of the following commands is to be run from the project root folder, typically from the project's Nix shell.

Run test suite with coverage statistics

pytest tests -vv --cov=.

Run formatters

black .
codespell
isort looptrace_napari tests

Run type checker

mypy looptrace_napari

Run linter

pylint looptrace_napari