py-quantaq is built to make it easy to access the QuantAQ REST API using Python. The most recent versions of the library can be found on PyPI and supports applications written using Python 3.6 and later.
Install the Library¶
The easiest way to install the library is from PyPI using pip, a package manager for Python:
$ pip install [-U] py-quantaq
Or, you can add the library to your project using poetry, an alternative python project management tool:
$ poetry add py-quantaq
You can also clone the repository locally and build from source using poetry:
$ git clone https://github.com/quant-aq/py-quantaq.git $ cd py-quantaq/ $ poetry install
Both the package you’re referencing and any dependencies must be installed.
Testing is done automagically with each new build. However, you can also run tests locally if you have cloned the library. To run tests locally using pytest:
$ poetry run pytest tests
To run them with coverage:
$ poetry run pytest tests --cov=quantaq --cov-report term-missing
All development takes place on GitHub. Please see the GitHub repository for instructions.
Reporting Bugs and Other Issues¶
Any bugs, issues, or questions can be reported using the GitHub Issues tracker. Please provide as much information as possible that will make it easier to solve/fix the problem. Useful information to include would be the operating system, python version, and version of the opcsim library as well as any dependencies. If there are issues with graphics, screenshots are very helpful!