Metadata-Version: 2.1
Name: cpfeed
Version: 0.6.0
Summary: CLI to check out current prices of cryptocurrencies. Powered by CoinGecko.
Home-page: https://github.com/0xBitzz/cpfeed
License: MIT
Author: 0xBitzz
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
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
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: typer[all] (>=0.9.0,<0.10.0)
Project-URL: Repository, https://github.com/0xBitzz/cpfeed
Description-Content-Type: text/markdown

# cpfeed (Crypto Price Feed)

`cpfeed` (short for Crypto Price Feed) is a Python package for fetching cryptocurrency prices from the [CoinGecko API](https://www.coingecko.com/api/documentation).

## Requirements

Before installing and using this project, make sure you have the following dependencies installed:

- [Python](https://www.python.org/downloads/) (`>= 3.9`).
- [Poetry](https://python-poetry.org/docs/).

## Installation

You can install `cpfeed` via pip:

```bash
pip3 install cpfeed
```

## Usage

1. Navigate to the `cpfeed` directory:

```sh
cd cpfeed
```

2. Activate the Poetry shell:

```sh
poetry shell
```

3. Fetch cryptocurrency prices:

```sh
cpfeed bitcoin
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.

## TODO

- Update usage examples with more detailed explanations.
- Add troubleshooting section for common issues.
- Add contributing guidelines.
- Add more commands.

