Metadata-Version: 2.3
Name: xmrig-api
Version: 0.0.1
Summary: Allows interacting with the XMRig API.
Project-URL: Homepage, https://github.com/hreikin/xmrig-api
Project-URL: Issues, https://github.com/hreikin/xmrig-api/issues
Author-email: hreikin <hreikin@gmail.com>
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: mkdocs-material
Requires-Dist: mkdocstrings[python]
Requires-Dist: requests
Description-Content-Type: text/markdown

# XMRig-API
[![PyPi](https://img.shields.io/badge/PyPi-0.0.1-green?labelColor=026ab5&style=flat-square&logo=pypi&logoColor=ffffff&link=https://pypi.org/project/xmrig-api/)](https://pypi.org/project/xmrig-api/)
![PyPI - Downloads](https://img.shields.io/pypi/dm/xmrig-api?label=PyPI%20Downloads)
![License](https://img.shields.io/github/license/hreikin/xmrig-api?label=License&color=green)

This module provides the `XMRigAPI` object to allow interacting with the XMRig API. Documentation is available [here](https://hreikin.co.uk/xmrig-api/) and can also be built locally if required.

## Getting Started

A quick overview of how to install and use this module can be found on the [Usage](usage.md) page, for a more detailed overview use the [Reference](reference.md) page.

## Contributing

Contributions are both encouraged and greatly appreciated, more information can be found on the [Contributing](CONTRIBUTING.md) page.

## Donations

If you'd like to support further development of XMRigAPI, you're welcome to send any amount of XMR to the following address:

`49ipjnJgoRnPsX8v5LVzUvfpSou6agomvKZnqD8zqFVqG6aqeUvKPyJ4WXhodiBPSvAuPNEmhF5QSiaJ59ZgFKwq9bXzCjz`