Metadata-Version: 2.4
Name: bittensor-burn-message
Version: 1.0.1
Summary: Bittensor subnet burn monitoring and Telegram alerts
Author: bittensor-burn-message contributors
License: MIT License
        
        Copyright (c) 2026 bittensor-burn-message contributors
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Keywords: bittensor,subnet,burn,emission,telegram,monitor,tao
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# bittensor-burn-message

Bittensor subnet burn-rate Telegram alerts on **Windows, Linux, and macOS**.

## Install

```bash
pip install bittensor-burn-message
```

From source:

```bash
pip install .
# or editable:
pip install -e .
```

Installs the **`bittensor-burn-message`** command.

**Linux:** if `command not found` after `pip install`, add `~/.local/bin` to PATH or use:

```bash
python3 -m bittensor_burn_message install
python3 -m bittensor_burn_message status
```

## Use

```bash
bittensor-burn-message install --telegram_token TOKEN --telegram_chat_id CHAT_ID
bittensor-burn-message wake                # start daemon when auto-start is installed but not running
bittensor-burn-message status
bittensor-burn-message stop                # pause burn monitoring
bittensor-burn-message resume              # resume burn monitoring
bittensor-burn-message shutdown            # stop daemon
bittensor-burn-message uninstall           # remove auto-start
bittensor-burn-message burn-snapshot       # send all subnet burn rates (test)
bittensor-burn-message burn-watch-once     # single burn poll
```

## Auto-start (after `install`)

| OS | Mechanism |
|----|-----------|
| Windows | Task Scheduler (logon + 5‑min watchdog) |
| Linux | systemd user service + 15‑min watchdog timer |
| macOS | LaunchAgent + 15‑min watchdog |

Runs until `bittensor-burn-message uninstall`. After login/reboot, auto-start waits for network, retries burn startup, and runs a 15‑min `wake` watchdog. If the daemon does not come up, run `bittensor-burn-message wake`.

## Telegram setup (burn alerts)

1. Message **@BotFather** → `/newbot` → copy the token.
2. Send your bot a message.
3. Open `https://api.telegram.org/bot<YOUR_TOKEN>/getUpdates` and copy `"chat":{"id": ...}`.
4. Run `bittensor-burn-message install --telegram_token ... --telegram_chat_id ...`.

Burn alerts use **your** bot/chat.
