Skip to main content

Axeprofiler provides a convenient CLI to create/save/apply AxeOS miner configs.

Project description

AxeProfiler

GNU GPLv3 license built with Python3

AxeProfiler provides a convenient CLI to create/save/apply AxeOS miner configs.

Navigate through a clean and simple CLI to create, save, and then apply various AxeOS configurations - all from your keyboard. No more tedious clicking through every device dashboard!

Requirements

  • python >= 3.11

    • requests >= 2.32.5
    • rich >= 14.2.0

    The python libraries are installed automatically during installation

Installation

[The Way of the Plebb]

@Mac | @Windows
Download the appropriate executable from here, and you should be able to simply double click and run the file to start the program - or you can call the executable directly from the terminal. See NOTES below.

@Linux
If you're already running Linux, please follow one of the methods found in The Way of the Dev outlined below. An executable may be added in the future; however, it's prefable to build from source or simply use python/pip to install from PYPI.

NOTES
The Windows' executable was generated for Windows 10/11 - support for older OS is not guaranteed.

The MAC executables are simply UNIX executable files. There is no specific file extension - they are Terminal apps, and running them is simply a matter of retaining (or allowing) the proper file permissions that your system needs to execute them. Look for the option that says "Open with Terminal."

Executables were created via the Python library pyinstaller by running the following command on each respective OS:

pyinstaller --onefile src/axeprofiler/__main__.py` (from source root)

This is NOT an installation step - it is only being shared in the spirit of transparency, given the nature of executables. If you don't feel comfortable running them, you are more than welcome to follow The Way of the Dev outlined below.

[The Way of the Dev]

Clone the repo and run pip install -e . from the project root directory. This should install all dependencies and add the axeprof command to PATH - allowing you to call the program from anywhere with that pip environment active.

(venv) <axeprofiler_directory>$ pip install -e .
(venv) $ axeprof

You can also install the package from PYPI

(venv) $ python -m pip install axeprofiler
(venv) $ axeprof

Once installed, you may also start the program from inside a python REPL by importing the entry-point function.

>>> # inside python REPL
>>> from axeprofiler.__main__ import main
>>> main()

Notes

  • This project is still in active development, and it's possible a few hidden bugs linger (though, they are actively hunted down).
  • While there are confirmation prompts, please do your due diligence to know which device (IP) you are applying a profile to.
  • Deleting a [selected] profile does not remove the configuration from an active miner running it.

While not expected, any tips/donations [in bitcoin] are greatly appreciated and go a long way in supporting me and my future contributions to this codebase and the bitcoin ecosystem in general. If you feel inclined to do so, please send to the secured address below. Much love <3

Addr: bc1q4fnuqgy4xlqgw3et76nqwz8u573xyhcgwmac8u

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

axeprofiler-1.1.4.tar.gz (8.6 MB view details)

Uploaded Source

Built Distribution

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

axeprofiler-1.1.4-py3-none-any.whl (29.1 kB view details)

Uploaded Python 3

File details

Details for the file axeprofiler-1.1.4.tar.gz.

File metadata

  • Download URL: axeprofiler-1.1.4.tar.gz
  • Upload date:
  • Size: 8.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.1

File hashes

Hashes for axeprofiler-1.1.4.tar.gz
Algorithm Hash digest
SHA256 926ef927da60af383ce6aa96565b9eb7c799b86a351e06a8020cdd63dfa19c05
MD5 ab16b14e01eb25d4301c1e40e6ff68bd
BLAKE2b-256 71260281e056f36d9ed756badbe52df52a1228dcc115d17b73d8778e1b16bfad

See more details on using hashes here.

File details

Details for the file axeprofiler-1.1.4-py3-none-any.whl.

File metadata

  • Download URL: axeprofiler-1.1.4-py3-none-any.whl
  • Upload date:
  • Size: 29.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.1

File hashes

Hashes for axeprofiler-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e04a9a8a0634ab348723bca425efdb819ce5740e44b7799c309d65ec65e90cb2
MD5 bffb66a1a4ad52e4ba51937928d80428
BLAKE2b-256 ec174876583ac5ced7ffdc5c233882df33f4a22cc1a8ab79fd8828ef50ee5478

See more details on using hashes here.

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