Installation

Basic Installation

pip install financelib

From Source

git clone https://github.com/yigitoo/financelib.git
cd financelib
pip install -e .

Optional Dependencies

FinanceLib has optional dependency groups for different features:

Trading BotsDatabase (PostgreSQL)Web ScrapingDevelopmentEverything

pip install financelib[bot]

Includes: ccxt, torch, transformers, flask, scikit-learn, tweepy

pip install financelib[db]

Includes: SQLAlchemy, psycopg2-binary

pip install financelib[scraping]

Includes: selenium

pip install financelib[dev]

Includes: pytest, ruff, mypy

pip install financelib[all]

Environment Variables

Set up API keys for full functionality:

# NewsAPI (required for news features)
export NEWS_API_APIKEY="your-api-key"

# Binance (required for crypto trading bot)
export BINANCE_API_KEY="your-key"
export BINANCE_API_SECRET="your-secret"

# Twitter/X (optional, for sentiment analysis)
export TWITTER_API_KEY="your-key"
export TWITTER_API_SECRET="your-secret"
export TWITTER_ACCESS_TOKEN="your-token"
export TWITTER_ACCESS_TOKEN_SECRET="your-token-secret"

Tip

Create a .env file in your project root and FinanceLib will load it automatically via python-dotenv.

Verify Installation

import financelib
print(financelib.__version__)  # 0.2.0