FIXME

Introduction

FIXME

Installation

The package can be installed with pip.

$ pip install FIXME

Getting started

FIXME

Contributing

Contributions are welcome. Make sure to first open an issue discussing the problem or the new feature before creating a pull request. The project uses poetry.

$ poetry install

You can run the tests with poetry run pytest.

$ poetry run pytest

The project must type-check with pyright. If you’re using VSCode the pylance extension should report diagnostics automatically. You can also install the type-checker locally with npm install and run it from the command-line.

$ npm run watch
$ npm run check

The code follows the black code style. Import statements are sorted with isort.

$ poetry run isort FIXME examples tests
$ poetry run black FIXME examples tests
$ poetry run black --check FIXME examples tests