/runeq-python

Python 3 Standard Development Kit (SDK) for Rune's query API

Primary LanguagePythonMIT LicenseMIT

runeq-python

PyPI - License PyPI - Python Version PyPI Documentation Status CircleCI Status

Python 3 Standard Development Kit (SDK) for Rune Lab's Query API: runeq

References

Installation

Python 3.8+ is required.

To install the library using pip:

pip3 install runeq

To install from source:

python3 setup.py install

Development

Initialize a virtual environment, with dev requirements installed:

make init

Run tests

make test
# With coverage
make test-coverage
# For a single test
make test-single

Lint

make lint

Preview documentation

make build-docs
  • This will build the documents in the docs directory. Open the index.html file in your browser to preview the documentation.

Build PyPI artifact:

make build-dist

Clean up ignored files/artifacts

make clean