-
Notifications
You must be signed in to change notification settings - Fork 1
Home
Jennings Zhang edited this page Jul 23, 2024
·
3 revisions
This wiki describes developing aiochris
itself.
For client-side documentation of aiochris
, see https://fnndsc.github.io/aiochris
Install rye.
git clone [email protected]:FNNDSC/aiochris.git
cd aiochris
rye sync
-
Start up miniCHRIS
-
rye run pytest
pdoc
can run its own HTTP server with hot-reloading:
rye run pdoc -p 7777 --no-browser --docformat numpy aiochris
However it can be buggy, so alternatively build the documentation and use http.server
:
rye run pdoc -o /tmp/pdoc --docformat numpy aiochris && rye run python -m http.server -d /tmp/pdoc 7777
-
Documentation style is Numpy: https://numpydoc.readthedocs.io/en/latest/format.html
-
Testing using Pytest: https://docs.pytest.org/en/8.2.x/
-
We love frozen dataclasses.