Herostatus


NameHerostatus JSON
Version 0.3.5 PyPI version JSON
download
home_pagehttps://github.com/freqnik/herostatus
SummaryHerominers console status and stats display for cryptonight miners
upload_time2023-11-25 01:44:04
maintainer
docs_urlNone
authorfreQniK
requires_python
licenseGPLv3
keywords crypto cryptonight zephyr bitcoin monero haven dero ergo blockchain mining randomx
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Herostatus
Herominers Status and Alarm Notifier

This will provide an interface to monitor your miners in a terminal.
It provides current hashrate, 1h,6h, and 24 hashrates and total number of hashes.

You can set from a number of alarm types for when a miner goes down.

Currently this chceks the if the 1 hour hashrate is 0. I noticed too many false
alarms with my miners when checking if current hashrate was 0. 

# Requiremnts
```
pip3 install json
pin3 install requests
pip3 install pygame
sudo apt-get install portaudio19-dev python3-pyaudio
```


## Installation

Via pip:

```shell
pip3 install herostatus
```

Via GitHub

```shell
git clone https://github.com/freQniK/Herostatus`
cd Herostatus
python3 herostatus.py
```

Install the above requirements and run *herostatus.py* with your python 3 interpreter. 

# Usage
```shell
(hero) freQniK>herostatus -h
pygame 2.5.2 (SDL 2.28.2, Python 3.8.10)
Hello from the pygame community. https://www.pygame.org/contribute.html
usage: herostatus [-h] [-s sound] [-t times]

Herominers Crypto Status and Alarm Notifier

optional arguments:
  -h, --help            show this help message and exit
  -s sound, --sound sound
                        Choose Your Alarm: 1. Burglar Alarm (30s) 2. Car Alarm (33s) 3. Hip Hop Alarm (10s) 4. Nuclear Alarm (60s) 5. Siren Alarm
                        (16s) 6. Strong Bad Alarm (Default) (17s)
  -t times, --times times
                        Number of times to sound the alarm before it becomes annoying

```

When you first run hersostatus it will prompt for the crypto you are mining. Be sure to enter the full name of the crypto, i.e., monero, dero, ergo, zephyr, etc.

It will also prompt you for your wallet address for your miners. Finally, it will prompt you for a refresh interval. Choose wisely. These settings are stored in **~/.herostatus/config.json** and reused upon restart. 

You can edit **config.json** if you feel like it to change any settings. It's a simple file. 

# Screenshot

![Screenshot](img/scrsht.png)

# Donations
Coding is a lot of work. Support your FOSS developers with a small contribution to keep them coding. Crypto is the easiest method to donate to your favorite FOSS project. 

## Bitcoin

```
bc1qjzrrqlk7t2pedfrnp25xqxru8nq3plv7ghkvag
```

![BTC](img/BTC.png)


## DERO
```
dero1qyxctkgzee00jh3md4etc8kxkr8x4hh7cckezrhn7de39kj4xaf9xqqa6xeta
```
![DERO](img/DERO.png)

## Monero

```
82sirs3qe2XCvytxCnkVyS5q6v18MN8vHgpU1hZECmnKQzzcVNB5vXiDMz1Ktdp4pgKKjK2vsWdGABN8AAtHbFAaDg7A63t
```

![XMR](img/XMR.png)

## Pirate Chain

```
zs1uknhdwh306h3r08l3vvd29jz0a0ym3tpxtad6j3en82g24hnzpuknuwt25r7vpsh86ly23fgjwp
```

![ARRR](img/ARRR.png)

## Zephyr
```
ZEPHs8jnJx1bKL6TdmDSfUZTMuWeFkVhye5JUg8g7QYUBizGB6u5scJixYPqLo4EQkCbjPKKxtpQJHHCEFf3qAP2QKCZBF9judW
```

![ZEPH](img/ZEPH.png)


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/freqnik/herostatus",
    "name": "Herostatus",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "crypto cryptonight zephyr bitcoin monero haven dero ergo blockchain mining randomx",
    "author": "freQniK",
    "author_email": "freqnik@mathnodes.com",
    "download_url": "https://files.pythonhosted.org/packages/71/31/cc5f4b68597f81b425b000475810d8a5a27b2720181199af078f4579ec5f/Herostatus-0.3.5.tar.gz",
    "platform": null,
    "description": "# Herostatus\nHerominers Status and Alarm Notifier\n\nThis will provide an interface to monitor your miners in a terminal.\nIt provides current hashrate, 1h,6h, and 24 hashrates and total number of hashes.\n\nYou can set from a number of alarm types for when a miner goes down.\n\nCurrently this chceks the if the 1 hour hashrate is 0. I noticed too many false\nalarms with my miners when checking if current hashrate was 0. \n\n# Requiremnts\n```\npip3 install json\npin3 install requests\npip3 install pygame\nsudo apt-get install portaudio19-dev python3-pyaudio\n```\n\n\n## Installation\n\nVia pip:\n\n```shell\npip3 install herostatus\n```\n\nVia GitHub\n\n```shell\ngit clone https://github.com/freQniK/Herostatus`\ncd Herostatus\npython3 herostatus.py\n```\n\nInstall the above requirements and run *herostatus.py* with your python 3 interpreter. \n\n# Usage\n```shell\n(hero) freQniK>herostatus -h\npygame 2.5.2 (SDL 2.28.2, Python 3.8.10)\nHello from the pygame community. https://www.pygame.org/contribute.html\nusage: herostatus [-h] [-s sound] [-t times]\n\nHerominers Crypto Status and Alarm Notifier\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -s sound, --sound sound\n                        Choose Your Alarm: 1. Burglar Alarm (30s) 2. Car Alarm (33s) 3. Hip Hop Alarm (10s) 4. Nuclear Alarm (60s) 5. Siren Alarm\n                        (16s) 6. Strong Bad Alarm (Default) (17s)\n  -t times, --times times\n                        Number of times to sound the alarm before it becomes annoying\n\n```\n\nWhen you first run hersostatus it will prompt for the crypto you are mining. Be sure to enter the full name of the crypto, i.e., monero, dero, ergo, zephyr, etc.\n\nIt will also prompt you for your wallet address for your miners. Finally, it will prompt you for a refresh interval. Choose wisely. These settings are stored in **~/.herostatus/config.json** and reused upon restart. \n\nYou can edit **config.json** if you feel like it to change any settings. It's a simple file. \n\n# Screenshot\n\n![Screenshot](img/scrsht.png)\n\n# Donations\nCoding is a lot of work. Support your FOSS developers with a small contribution to keep them coding. Crypto is the easiest method to donate to your favorite FOSS project. \n\n## Bitcoin\n\n```\nbc1qjzrrqlk7t2pedfrnp25xqxru8nq3plv7ghkvag\n```\n\n![BTC](img/BTC.png)\n\n\n## DERO\n```\ndero1qyxctkgzee00jh3md4etc8kxkr8x4hh7cckezrhn7de39kj4xaf9xqqa6xeta\n```\n![DERO](img/DERO.png)\n\n## Monero\n\n```\n82sirs3qe2XCvytxCnkVyS5q6v18MN8vHgpU1hZECmnKQzzcVNB5vXiDMz1Ktdp4pgKKjK2vsWdGABN8AAtHbFAaDg7A63t\n```\n\n![XMR](img/XMR.png)\n\n## Pirate Chain\n\n```\nzs1uknhdwh306h3r08l3vvd29jz0a0ym3tpxtad6j3en82g24hnzpuknuwt25r7vpsh86ly23fgjwp\n```\n\n![ARRR](img/ARRR.png)\n\n## Zephyr\n```\nZEPHs8jnJx1bKL6TdmDSfUZTMuWeFkVhye5JUg8g7QYUBizGB6u5scJixYPqLo4EQkCbjPKKxtpQJHHCEFf3qAP2QKCZBF9judW\n```\n\n![ZEPH](img/ZEPH.png)\n\n",
    "bugtrack_url": null,
    "license": "GPLv3",
    "summary": "Herominers console status and stats display for cryptonight miners",
    "version": "0.3.5",
    "project_urls": {
        "Homepage": "https://github.com/freqnik/herostatus"
    },
    "split_keywords": [
        "crypto",
        "cryptonight",
        "zephyr",
        "bitcoin",
        "monero",
        "haven",
        "dero",
        "ergo",
        "blockchain",
        "mining",
        "randomx"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "40d2585199fa87c1785f087eeb5698886e5d23633c360017dab058544f7075ae",
                "md5": "bda97c48c2e795ec2a04ae0a71e84aa3",
                "sha256": "e0753dbfb26abafbcc1017700b4ac1f7ea7de10f2887348b975b70f79c21f5f2"
            },
            "downloads": -1,
            "filename": "Herostatus-0.3.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bda97c48c2e795ec2a04ae0a71e84aa3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 26219775,
            "upload_time": "2023-11-25T01:43:50",
            "upload_time_iso_8601": "2023-11-25T01:43:50.151009Z",
            "url": "https://files.pythonhosted.org/packages/40/d2/585199fa87c1785f087eeb5698886e5d23633c360017dab058544f7075ae/Herostatus-0.3.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7131cc5f4b68597f81b425b000475810d8a5a27b2720181199af078f4579ec5f",
                "md5": "d3b9e477b4ee8166981f68b6d0b7f8e3",
                "sha256": "5b585dc36e69df418d0b939f89eb66bd8e57d51e14e723586ac7486d26e81c8a"
            },
            "downloads": -1,
            "filename": "Herostatus-0.3.5.tar.gz",
            "has_sig": false,
            "md5_digest": "d3b9e477b4ee8166981f68b6d0b7f8e3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 26223951,
            "upload_time": "2023-11-25T01:44:04",
            "upload_time_iso_8601": "2023-11-25T01:44:04.617578Z",
            "url": "https://files.pythonhosted.org/packages/71/31/cc5f4b68597f81b425b000475810d8a5a27b2720181199af078f4579ec5f/Herostatus-0.3.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-25 01:44:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "freqnik",
    "github_project": "herostatus",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "herostatus"
}
        
Elapsed time: 3.07185s