Skip to content

Commit

Permalink
[Maint] Improve contribution in README and remove pyqt5 from [dev] in…
Browse files Browse the repository at this point in the history
…stall dependency (#188)

* remove pyqt5 from [dev]
* Update README.md
* Clarify tests and Qt backend in README
  • Loading branch information
psobolewskiPhD committed Nov 27, 2023
1 parent 969fefb commit 35e5acc
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 12 deletions.
36 changes: 25 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,21 +87,35 @@ use of the plugin follow.

## Contributing

Contributions are very welcome and a detailed contributing guide is coming soon.

Tests are run with `pytest`.

We use [`pre-commit`](https://pre-commit.com) to sort imports with
[`isort`](https://github.com/timothycrosley/isort), format code with
[`black`](https://github.com/psf/black), and lint with
[`flake8`](https://github.com/PyCQA/flake8) automatically prior to each commit.
To minmize test errors when submitting pull requests, please install `pre-commit`
in your environment as follows:
Contributions are very welcome and a detailed contributing guide is coming soon.
In the meantime, clone this repository and install it in editable mode using `pip`.
We recommend using a virtual environment, for example `conda`.
> [!IMPORTANT]
> Ensure you have a suitable Qt backend for napari! We recommend `PyQt5`.
> For more information, see the napari [Qt backend installation guide](https://napari.org/stable/tutorials/fundamentals/installation.html#choosing-a-different-qt-backend)
```sh
pre-commit install
conda create -n nap-anim python=3.10
conda activate nap-anim
pip install -e ".[dev]" PyQt5

```

Tests are run with `pytest`.
You can make sure your `[dev]` installation is working properly by running
`pytest .` from within the repository.

> [!NOTE]
> We use [`pre-commit`](https://pre-commit.com) to sort imports with
> [`isort`](https://github.com/timothycrosley/isort), format code with
> [`black`](https://github.com/psf/black), and lint with
> [`flake8`](https://github.com/PyCQA/flake8) automatically prior to each commit.
> To minmize test errors when submitting pull requests, please install `pre-commit`
> in your environment as follows:
> ```sh
> pre-commit install
> ```
## License

Distributed under the terms of the [BSD-3] license,
Expand Down
1 change: 0 additions & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ dev =
flake8
isort
check-manifest
PyQt5>=5.12.3,!=5.15.0
%(testing)s


Expand Down

0 comments on commit 35e5acc

Please sign in to comment.