Welcome to paquo 👋, a library for interacting with QuPath
from python.
paquo lives in github.
Its goal is to provide a pythonic interface to important features of QuPath, and to make creating and working with QuPath projects intuitive for python programmers.
We strive to make your lives as easy as possible: If Paquo is not pythonic,
unintuitive, slow or if its documentation is confusing, it's a bug in
Paquo. Feel free to report any issues or feature requests in the issue
tracker!
You can find paquo's documentation at paquo.readthedocs.io ❤️
- Install conda and git
- Clone paquo
git clone https://github.com/bayer-science-for-a-better-life/paquo.git - Run
conda env create -f environment.yaml - Activate the environment
conda activate paquo
Note that in this environment paquo is already installed in development mode,
so go ahead and hack.
- Please follow pep-8 conventions but:
- We allow 120 character long lines (try anyway to keep them short)
- Please use numpy docstrings.
- When contributing code, please try to use Pull Requests.
- tests go hand in hand with modules on
testspackages at the same level. We usepytest.
You can setup your IDE to help you adhering to these guidelines.
(Santi is happy to help you setting up pycharm in 5 minutes)