Add README.md with Hugging Face Space metadata

README.md

@@ -1,239 +1,8 @@
-# FinRyver
-
-FinRyver is an enterprise-grade financial statement automation platform built with Python and FastAPI. It streamlines the extraction, transformation, and reporting of financial data from Excel trial balances, enabling rapid generation of standardized Profit & Loss, Balance Sheet, and Cash Flow statements. The solution is designed for professional accounting, audit, and finance teams seeking robust, scalable, and auditable automation.
-
 ---
-
-## Table of Contents
-1. [Overview](#overview)
-2. [Key Features](#key-features)
-3. [Architecture & Project Structure](#architecture--project-structure)
-4. [Setup & Installation](#setup--installation)
-5. [Usage](#usage)
-6. [API Reference](#api-reference)
-7. [Development & Contribution](#development--contribution)
-8. [License](#license)
-
----
-
-## Overview
-
-FinRyver automates the end-to-end workflow for financial statement preparation:
-- Ingest Excel trial balances and supporting schedules
-- Extract, normalize, and map financial data using configurable rules
-- Generate P&L, Balance Sheet, and Cash Flow statements in Excel and JSON formats
-- Produce audit-ready notes and disclosures, with optional LLM-powered enrichment
-- Deployable as a REST API or via batch scripts; supports containerization for cloud/on-premise environments
-
-## Key Features
-
-- **Excel Upload & Parsing:** Accepts complex trial balances and schedules in Excel format
-- **Automated Data Extraction:** Configurable mapping and rules for robust data normalization
-- **Financial Statement Generation:** Produces P&L, Balance Sheet, and Cash Flow statements in standardized formats
-- **Notes & Disclosures:** Generates notes in JSON/Markdown, with LLM integration for advanced commentary
-- **RESTful API:** FastAPI-powered endpoints for seamless integration with other systems
-- **Scriptable Pipeline:** Modular Python scripts for batch processing and automation
-- **Docker Support:** Ready for containerized deployment in CI/CD or cloud environments
-- **Audit Trail:** Logging and error handling for traceability and compliance
-
-## Architecture & Project Structure
-
-- `notes/` — Main FastAPI API endpoints, business logic, and utility modules
-- `pnl/` — Scripts for Profit & Loss statement processing
-- `bs/` — Scripts for Balance Sheet processing
-- `cf/` — Scripts for Cash Flow statement processing
-- `config/` — Mapping and rules (JSON) for data normalization and extraction
-- `data/` — All input, output, and intermediate files (Excel, JSON, etc.)
-  - `data/input/` — Uploaded Excel files (source data)
-  - `data/output1/`, `data/output2/`, `data/output3/` — Intermediate and final output files
-  - `data/csv_notes_pnl/`, `data/csv_notes_bs/`, `data/csv_notes_cfs/` — Extracted notes in CSV format
-  - `data/generated_notes/`, `data/generated_notes_excel/` — Generated notes in JSON/Excel
-- `requirements.txt` — Python dependencies
-- `Dockerfile`, `docker-compose.yml` — Containerization assets
-- `.env` — Environment configuration
-
-## Setup & Installation
-
-### Prerequisites
-- Python 3.9+
-- pip
-- Docker (optional)
-
-### Clone the Repository
-```sh
-git clone https://github.com/santhoshmallojwala/FinRyver.git
-cd FinRyver
-```
-
-### Install Python Dependencies
-```sh
-pip install -r requirements.txt
-```
-
-### Configure Environment
-- Place your Excel trial balance(s) in the `input/` directory
-- Edit `.env` for custom settings (API keys, file paths, etc.)
-
-## Usage
-
-### Run the API Server (Development)
-```sh
-uvicorn app:app --reload
-```
-or if your main entrypoint is `main.py`:
-```sh
-uvicorn main:app --reload
-```
-
-### Batch Processing via Scripts
-```sh
-python pnl/sircodepnl.py
-python pnl/csv_json_pnl.py
-python pnl/pnl_note.py
-```
-
-### Docker Deployment
-```sh
-docker-compose up --build
-```
-
-## API Reference
-
-### API Endpoints
-
-#### `POST /pnl_from_notes`
-**Description:** Upload an Excel file, run the full P&L pipeline, and receive the generated Profit & Loss statement as an Excel file.
-**Input:**
-  - `file` (required): Excel file (`.xlsx`) containing trial balance data. Use `multipart/form-data`.
-**Output:**
-  - Returns the generated P&L Excel file as a download.
-```json
-{
-  "file": "pnl_statement.xlsx"
-}
-```
-
-#### `POST /bs_from_notes`
-**Description:** Upload an Excel file, run the full Balance Sheet pipeline, and receive the generated Balance Sheet as an Excel file.
-**Input:**
-  - `file` (required): Excel file (`.xlsx`) containing trial balance data. Use `multipart/form-data`.
-**Output:**
-  - Returns the generated Balance Sheet Excel file as a download.
-```json
-{
-  "file": "balance_sheet.xlsx"
-}
-```
-
-
-#### `POST /cf_from_notes`
-**Description:** Upload an Excel file, run the full Cash Flow pipeline, and receive the generated Cash Flow statement as an Excel file.
-**Input:**
-  - `file` (required): Excel file (`.xlsx`) containing trial balance data. Use `multipart/form-data`.
-**Output:**
-  - Returns the generated Cash Flow Excel file as a download.
-```json
-{
-  "file": "cash_flow_statements.xlsx"
-}
-```
-
-#### `POST /notes/json`
-**Description:** Upload an Excel file and generate notes as JSON. Optionally filter by note number.
-**Input:**
-  - `file` (required): Excel file (`.xlsx`) containing trial balance data. Use `multipart/form-data`.
-  - `note_number` (optional): Comma-separated string of note numbers to filter (e.g., `16,17,18`).
-**Output:**
-  - JSON object containing a list of notes.
-```json
-{
-  "notes": [ ... ]
-}
-```
-
-#### `POST /notes/text`
-**Description:** Upload an Excel file and generate notes as Markdown text. Optionally filter by note number.
-**Input:**
-  - `file` (required): Excel file (`.xlsx`) containing trial balance data. Use `multipart/form-data`.
-  - `note_number` (optional): Comma-separated string of note numbers to filter.
-**Output:**
-  - Plain text (Markdown) containing the generated notes.
-
-#### `POST /cf`
-**Description:** Generate a Cash Flow statement. No file upload required.
-**Input:** None.
-**Output:**
-  - JSON object with message and file path to the generated Cash Flow Excel file.
-```json
-{
-  "message": "Cash Flow report generated successfully as 'cashflow_excel/cashflow_report.xlsx'."
-}
-```
-
-#### `POST /bs`
-**Description:** Generate a Balance Sheet from existing data. No file upload required.
-**Input:** None.
-**Output:**
-  - JSON object with message and file path to the generated Balance Sheet Excel file.
-```json
-{
-  "message": "Balance Sheet report generated successfully as 'balancesheet_excel/balancesheet_report.xlsx'."
-}
-```
-
-#### `POST /pnl`
-**Description:** Generate a Profit & Loss statement from existing data. No file upload required.
-**Input:** None.
-**Output:**
-  - JSON object with message and file path to the generated P&L Excel file.
-```json
-{
-  "message": "P&L report generated successfully as 'pnl_excel/pnl_report.xlsx'."
-}
-```
-
-#### `POST /new`
-**Description:** Upload an Excel file and generate notes using LLM, saved as Excel. Optionally filter by note number.
-**Input:**
-  - `file` (required): Excel file (`.xlsx`) containing trial balance data. Use `multipart/form-data`.
-  - `note_number` (optional): Comma-separated string of note numbers to filter.
-**Output:**
-  - JSON object with message and file path to the generated notes Excel file.
-```json
-{
-  "message": "Notes generated. Excel saved at generated_notes_excel/notes.xlsx."
-}
-```
-
-#### `POST /hardcoded`
-**Description:** Run the full hardcoded pipeline: extract, process, filter, and convert to Excel. Optionally filter by note number.
-**Input:**
-  - `file` (required): Excel file (`.xlsx`) containing trial balance data. Use `multipart/form-data`.
-  - `note_number` (optional): Comma-separated string of note numbers to filter.
-**Output:**
-  - JSON object with message and file path to the generated Excel file.
-```json
-{
-  "message": "Pipeline completed successfully. Excel file saved in output3."
-}
-```
-
-## Development & Contribution
-
-### Local Development
-- Fork and clone the repository
-- Create a feature branch (`git checkout -b feature/my-feature`)
-- Commit and push changes
-- Submit a pull request
-
-### Coding Standards
-- PEP8 compliance
-- Type annotations and docstrings
-- Logging and error handling for all modules
-
-### Issue Tracking
-- Use GitHub Issues for bugs, enhancements, and feature requests
-
-## License
-
-This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+title: FinRyver
+emoji: 🌖
+colorFrom: yellow
+colorTo: yellow
+sdk: docker
+pinned: false
+---