financial-engine 0.1.0

A time-machine style financial backtesting and ratio analysis engine

📊 Financial Engine

A time-machine for market data — replay and analyze historical financial data for one or more companies across single or multiple dates.

Built to backtest strategies, calculate financial ratios, and accelerate data analysis using a smart caching mechanism.

---

✨ Features

• 📈 Calculate financial ratios on-demand
• 🔁 Perform rolling computations for line items
• ⚡ Caching mechanism for fast range-date processing

---

🚀 Installation

pip install financial-engine

Step-by-step

1. Create and activate a virtual environment:

   python -m venv .venv
   source .venv/bin/activate  # or .venv\Scripts\activate on Windows
   

2. Create a .env file in the root of your project:

   MONGO_URI=
   MONGO_DATABASE=
   MONGO_COLLECTION=
   AWS_ACCESS_KEY_ID=
   AWS_SECRET_ACCESS_KEY=
   BUCKET_NAME=
   

3. Install the package:

   pip install financial-engine
   

---

🐍 Requirements

• Python ≥ 3.9
• Compatible with major OS environments (Linux, Windows, Mac)

---

🛠 Implemented Methods

Method	Description
get_ratios()	Get financial ratios for a single company on a specific date
get_ratios_range()	Fetch financial ratios for a company across a date range

---

📦 Usage Example

from financial_engine.core.engine import FinancialEngine

fe = FinancialEngine()

ratios_df = await fe.get_ratios_range(
    alpha_code="RELIANCE",
    start_date="2023-01-01",
    end_date="2023-01-15"
)
print(ratios_df)

---

🧪 Testing

To test in a local project:

1. Create a .env file with valid AWS and Mongo credentials.
2. Install development dependencies:

   pip install -r requirements.txt
   

3. Run your test script using the API.

---