Skip to main content

Allows interacting with the XMRig API.

Project description

XMRig-API

XMRig-API is a Python module that enables seamless interaction with the XMRig API, offering a range of features designed to enhance usability, flexibility, and reliability. Detailed documentation is available here, and can also be built locally if needed.

Getting Started

To get started with XMRig-API, visit the Usage page for a quick installation and usage guide. For an in-depth overview of the module’s capabilities, consult the reference pages available at the documentation site.

Features

XMRig-API includes several powerful features:

  • Support for Multiple Miners: Configure and manage multiple miners from a single instance.
  • Data Persistence (Planned): Upcoming database support to ensure resilience and prevent data loss during API or miner restarts.
  • Comprehensive Test Coverage: A robust test suite for enhanced reliability and easier development.
  • Getting Started Examples: Practical examples to help new users quickly understand and use the tool.
  • Reference Documentation: Detailed documentation to guide you through all features and functions.

These features make XMRig-API an ideal solution for both miners and developers seeking a user-friendly and robust tool.

Contributing

Contributions are always welcome and greatly appreciated! To learn more about how you can contribute, check out the Contributing page.

Credits and Acknowledgments

XMRig-API originated as a fork of the python-xmrig project. While the original project provided the foundation, XMRig-API has evolved into a distinct tool with its own unique features and direction.

Special thanks to the creators of python-xmrig for their foundational work, which inspired the development of this project.

Donations

If you find XMRig-API useful and would like to support its development, consider sending a donation in XMR to the following address:

49ipjnJgoRnPsX8v5LVzUvfpSou6agomvKZnqD8zqFVqG6aqeUvKPyJ4WXhodiBPSvAuPNEmhF5QSiaJ59ZgFKwq9bXzCjz

Your support is greatly appreciated!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xmrig_api-0.0.6.tar.gz (27.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xmrig_api-0.0.6-py3-none-any.whl (3.0 kB view details)

Uploaded Python 3

File details

Details for the file xmrig_api-0.0.6.tar.gz.

File metadata

  • Download URL: xmrig_api-0.0.6.tar.gz
  • Upload date:
  • Size: 27.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for xmrig_api-0.0.6.tar.gz
Algorithm Hash digest
SHA256 c21eda2357822a1a254edd4d2781e10213b05b133d5ba1da1e1fbecab7ee3ce3
MD5 a2d280af441ffbe8e2c6fbf5cb73624c
BLAKE2b-256 d77ee543f680565ba06edb904695e4f2f01597c4e4aeede6f328eb219c93d5bc

See more details on using hashes here.

Provenance

The following attestation bundles were made for xmrig_api-0.0.6.tar.gz:

Publisher: release.yml on hreikin/xmrig-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file xmrig_api-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: xmrig_api-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 3.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for xmrig_api-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 8e593f6f51a542003adb0c826528fb5e2c50596881f6a24f01f389c108aa3f03
MD5 b93ef2a5ff7c1aa79a57cb6cc6cd097c
BLAKE2b-256 51fe63180508c0df2f330a02511943cbfc1a56c75ab914cb0534c7d04ab835a7

See more details on using hashes here.

Provenance

The following attestation bundles were made for xmrig_api-0.0.6-py3-none-any.whl:

Publisher: release.yml on hreikin/xmrig-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page