Metadata-Version: 2.1
Name: cryptobeacon
Version: 1.0.0
Summary: CryptoBeacon is a simple command-line interface tool for cryptocurrency alerts directly into your desktop.
License: MIT
Author: Eduardo V. e Sousa
Author-email: eduardoatrcomp@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: requests (>=2.28.0,<3.0.0)
Requires-Dist: rich (>=12.4.4,<13.0.0)
Requires-Dist: typer[all] (>=0.4.1,<0.5.0)
Description-Content-Type: text/markdown

# 🚨 CryptoBeacon

[![Linux](https://svgshare.com/i/Zhy.svg)](https://svgshare.com/i/Zhy.svg)
[![Python](https://img.shields.io/badge/python-3.10-blue)](https://www.python.org/)

CryptoBeacon is a simple command-line interface tool for cryptocurrency alerts directly into your desktop. It uses the free [CoinGecko API](https://www.coingecko.com/en/api/documentation) to obtain the current prices, sending desktop notification when alarm price targets are reached. The application is built in [Python](https://www.python.org/), with the help of [Typer](https://github.com/tiangolo/typer) and [Rich](https://github.com/Textualize/rich).

![watchlist](./imgs/watchlist.png)

## Installation

```Bash
pip install --user cryptobeacon
```

## Usage

Tracking your favorite cryptocurrencies with **CryptoBeacon** is easy. Start by **adding** them to the watchlist, as follows:

```Bash
cryptobeacon coin add bitcoin
```

Confirm the addition using the **show** command:

```Bash
cryptobeacon show
```

Next, you need to add a price target for the **alarm**:

```Bash
cryptobeacon alarm add bitcoin 21000
```

Finally, **run** the application:

```Bash
cryptobeacon run
```

> ⚠️ Additionally, there are commands to **remove** coins and alarms from the watchlist, or even to **clear** it entirely. Use the **help** commando for more specific information.

