README.md

metadata

title: Crypto Analyst Agent
emoji: 😻
colorFrom: gray
colorTo: gray
sdk: gradio
sdk_version: 5.49.1
app_file: app.py
pinned: false
license: apache-2.0
short_description: Collect data, analyze and report on crypto

Crypto Analyst Agent 📈

An interactive Gradio app that collects crypto market information, runs analysis (pricing + indicators + sentiment), and generates a concise report to support research and decision-making.

⚠️ Educational project only — not financial advice.

What it does

• Fetches market data (price, market cap, volume, etc.)
• Pulls historical data for trend/returns analysis
• Runs analytics (basic performance + volatility-style metrics depending on configuration)
• Incorporates sentiment signals (tool-based sentiment module)
• Generates a structured report in a single workflow

Project structure

.
├── app.py
├── tools/
│   ├── __init__.py
│   ├── market_data.py
│   ├── historical_data_tool.py
│   ├── analytics_tool.py
│   └── sentiment_tool.py
├── requirements.txt
└── README.md

Getting started (local)

1. Clone and install

git clone https://github.com/cicboy80/CRYPTO_ANALYST_AGENT.git
cd CRYPTO_ANALYST_AGENT
python -m venv .venv
source .venv/bin/activate   # macOS/Linux
# .venv\Scripts\activate    # Windows
pip install -r requirements.txt

2. Environment variables

This project uses API keys for OpenAI and CoinGecko.

Set these as environment variables (recommended), or create a local .env file (do not commit it).

Required:

• OPENAI_API_KEY
• COINGECKO_API_KEY

Example:

export OPENAI_API_KEY="..."
export COINGECKO_API_KEY="..."

3. Run the app

python app.py

Then open the local Gradio URL printed in the terminal.

Hugging Face Spaces: Secrets setup

Add the following under Settings → Secrets in your Space:

• OPENAI_API_KEY
• COINGECKO_API_KEY

Deploying on Hugging Face Spaces

1. Create a new Gradio Space
2. Add your repo files (app.py, tools/, requirements.txt, README.md)
3. Add required keys under Settings → Secrets

Notes on security

• Never commit secrets (API keys, tokens, .env, certificates)
• Keep credentials in Hugging Face Secrets (or your cloud provider’s secret manager)

Roadmap

• Add caching for API responses
• Expand analytics (risk metrics, drawdown, rolling volatility)
• Improve reporting format (markdown + export)

License

Apache-2.0