qirest-client: Quantitative Imaging Profile REST client¶
Synopsis¶
The Quantitative Imaging Profile (QiPr) REST client interacts with the qiprofile REST server.
API: | https://qirest-client.readthedocs.org/en/latest/api/index.html |
---|---|
Git: | https://github.com/ohsu-qin/qirest-client |
Installation¶
- Install the qiprofile REST server.
- Add
qirest-client
to your Python project setup.pyinstall_requires
. - Update your project installation to reflect the REST client dependency.
- Start the qiprofile REST server.
Usage¶
See the qiprofile REST Data Model and API documentation.
Development¶
Testing is performed with the nose package, which must be installed separately.
Documentation is built automatically by ReadTheDocs when the project is pushed to GitHub. Documentation can be generated locally as follows:
Install Sphinx, if necessary.
Run the following in the
doc
subdirectory:make html