name changed to FinRyver

README.md

@@ -1,6 +1,6 @@
-# AGRAccountsAudit
+# FinRyver
 
-AGRAccountsAudit 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.
+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.
 
 ---
 
@@ -18,7 +18,7 @@ AGRAccountsAudit is an enterprise-grade financial statement automation platform
 
 ## Overview
 
-AGRAccountsAudit automates the end-to-end workflow for financial statement preparation:
+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
@@ -38,13 +38,16 @@ AGRAccountsAudit automates the end-to-end workflow for financial statement prepa
 
 ## Architecture & Project Structure
 
-- `app/` — FastAPI API endpoints, business logic, and utility modules
-- `pnlbs/` — Financial extraction and reporting scripts (P&L, BS)
-- `cf/` — Financial extraction and reporting scripts (CF)
+- `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
-- `input/` — Uploaded Excel files (source data)
-- `output*` — Generated output files (Excel, JSON)
-- `csv_notes_pnl/`, `generated_notes*`, `balancesheet_excel/`, `cashflow_excel/`, `pnl_excel/` — Intermediate and final report folders
+- `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
@@ -58,8 +61,8 @@ AGRAccountsAudit automates the end-to-end workflow for financial statement prepa
 
 ### Clone the Repository
 ```sh
-git clone https://github.com/santhoshmallojwala/AGRAccountsAudit.git
-cd AGRAccountsAudit
+git clone https://github.com/santhoshmallojwala/FinRyver.git
+cd FinRyver
 ```
 
 ### Install Python Dependencies
@@ -75,14 +78,18 @@ pip install -r requirements.txt
 
 ### Run the API Server (Development)
 ```sh
-uvicorn app.api:app --reload
+uvicorn app:app --reload
+```
+or if your main entrypoint is `main.py`:
+```sh
+uvicorn main:app --reload
 ```
 
 ### Batch Processing via Scripts
 ```sh
-python pnlbs/sircodepnl.py
-python pnlbs/csv_json_pnl.py
-python pnlbs/pnl_note.py
+python pnl/sircodepnl.py
+python pnl/csv_json_pnl.py
+python pnl/pnl_note.py
 ```
 
 ### Docker Deployment
@@ -99,10 +106,9 @@ docker-compose up --build
 **Input:**
   - `file` (required): Excel file (`.xlsx`) containing trial balance data. Use `multipart/form-data`.
 **Output:**
-  - JSON object with message and file path to the generated P&L Excel file.
+  - Returns the generated P&L Excel file as a download.
 ```json
 {
-  "message": "Profit and Loss statement generated successfully.",
   "file": "pnl_statement.xlsx"
 }
 ```
@@ -112,23 +118,23 @@ docker-compose up --build
 **Input:**
   - `file` (required): Excel file (`.xlsx`) containing trial balance data. Use `multipart/form-data`.
 **Output:**
-  - JSON object with message and file path to the generated Balance Sheet Excel file.
+  - Returns the generated Balance Sheet Excel file as a download.
 ```json
 {
-  "message": "Balance Sheet generated successfully.",
   "file": "balance_sheet.xlsx"
 }
 ```
 
-#### `POST /cf`
-**Description:** Generate a Cash Flow statement from existing data (no file upload required).
+
+#### `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:**
-  - No input required.
+  - `file` (required): Excel file (`.xlsx`) containing trial balance data. Use `multipart/form-data`.
 **Output:**
-  - JSON object with message and file path to the generated Cash Flow Excel file.
+  - Returns the generated Cash Flow Excel file as a download.
 ```json
 {
-  "message": "Cash Flow report generated successfully as 'cashflow_excel/cashflow_report.xlsx'."
+  "file": "cash_flow_statements.xlsx"
 }
 ```
 

docker-compose.yml

@@ -1,7 +1,7 @@
 services:
   app:
     build: .
-    container_name: Financial-Statements
+    container_name: FinRyver
     volumes:
       - .:/app
     ports: