Python Command Line Interface to access MSK MIND.
Documentation site: https://msk-mind.github.io/cli
Please refer to the documentation site for installation steps and examples.
The documentation in this directory was created using Sphinx.
The makefile and conf.py was generated using,
$ sphinx-quicksart There is no need to regenerate the makefile.
To edit this documentation and publish to github pages, edit the .rst files in docsource and follow the instructions below. Make sure to git pull before editing and committing to avoid code conflicts in auto-generated html files.
$ python3 -m venv env
$ source env/bin/activate
(venv)$ cd docs
(venv)$ pip install -r ../requirements.txt
(venv)$
(venv)$ git pull
(venv)$ make github
(venv)$ git commit -am "YOUR COMMIT MESSAGE"
(venv)$ git push origin master
(venv)$ deactivate
Note that while this repo is private, the documentation that gets publised to github pages is public.
The CLI uses a Python package automatically generated by the OpenAPI Generator project from the core Java API. Please see the API Client documentation here.
