Metadata-Version: 2.4
Name: runeq
Version: 0.18.1
Summary: Query data from Rune Labs APIs
Home-page: https://github.com/rune-labs/runeq-python
Author: Rune Labs
Maintainer-email: support@runelabs.io
Keywords: rune labs api query data
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: boto3>=1.23.0
Requires-Dist: click>=7.1
Requires-Dist: gql[requests]>=3.5.0
Requires-Dist: numpy>=1.18.2
Requires-Dist: PyYAML>=5.3.1
Requires-Dist: requests>=2.23.0
Requires-Dist: pandas>=1.1.5
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license-file
Dynamic: maintainer-email
Dynamic: requires-dist
Dynamic: summary

# runeq-python

![PyPI - License](https://img.shields.io/pypi/l/runeq)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/runeq)
![PyPI](https://img.shields.io/pypi/v/runeq)
[![Documentation Status](https://readthedocs.org/projects/runeq/badge/?version=latest)](https://runeq.readthedocs.io/en/latest/?badge=latest)
[![CircleCI Status](https://circleci.com/gh/rune-labs/runeq-python.svg?style=shield)](https://app.circleci.com/pipelines/gh/rune-labs/runeq-python)

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

## References

* Library documentation: [https://runeq.readthedocs.io/en/latest](https://runeq.readthedocs.io/en/latest)
* API documentation: [https://docs.runelabs.io](https://docs.runelabs.io)
* Rune Labs home page: [https://runelabs.io](https://runelabs.io)

## 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
