Metadata-Version: 2.1
Name: python-caw
Version: 0.0.1
Summary: A Python package for wrapping common Crypto APIs like Etherscan, Messari, CoinGecko, FTMscan Coin Market Cap, etc.
Home-page: 
Author: Unique Divine
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/Unique-Divine/python-crypto-api-wrappers/issues
Project-URL: Source Code, https://github.com/Unique-Divine/python-crypto-api-wrappers
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE

# python-crypto-api-wrappers

Python Crypto API Wrappers (`pycaw`) is a package for connecting to cryptocurrency APIs like Etherscan, Messari, CoinGecko, and Coin Market Cap.


# Setup and Installation

You'll need to add your API keys as environment variables in order to use different sections of the "crypto_apis" package. The package expects a `.env` file at the repo root to set each constant.

```bash
# Example .env file that needs to be created at the root of the repo:
ETHERSCAN_API_KEY = ""
COINMARKETCAP_API_KEY = ""
MESSARI_API_KEY = ""
FTMSCAN_API_KEY = ""
```

TODO: `set_env_vars.py` or `set_env_vars.sh`: Write a script to create the .env file for the user.

# Usage Instructions

---

## Messari

Messari sub-section is forked from [messari/messari-python-api](https://github.com/messari/messari-python-api), the official Python client for the Messari API.

Example notebooks:
- [Messari API Tutorial.ipynb][messari-api-nb-example-nbviewer]
- [DefiLlama API Tutorial.ipynb][defillama-nb-example-nbviewer]


[defillama-nb-example]: https://github.com/messari/messari-python-api/blob/master/examples/notebooks/DeFiLlama%20API%20Tutorial.ipynb
[defillama-nb-example-nbviewer]:https://nbviewer.jupyter.org/github/messari/messari-python-api/blob/master/examples/notebooks/DeFiLlama%20API%20Tutorial.ipynb

[messari-api-nb-example]: https://github.com/messari/messari-python-api/blob/master/examples/notebooks/Messari%20API%20Tutorial.ipynb
[messari-api-nb-example-nbviewer]: https://nbviewer.jupyter.org/github/messari/messari-python-api/blob/master/examples/notebooks/Messari%20API%20Tutorial.ipynb

---

TODO: .
- [ ] Usage instructions.
- [ ] pypi pip install isntructions.
- [ ] See about conda-force listing.
- [ ] Dependencies and and the requirements file
- [ ] Etherscan functions
- [ ] Messari tests
- [ ] CoinGecko



