processCASpdf 0.3.1__tar.gz

processcaspdf-0.3.1/.github/workflows/publish.yml

@@ -0,0 +1,28 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch: {}
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # required for PyPI trusted publishing (OIDC)
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Build
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish

processcaspdf-0.3.1/.gitignore

@@ -0,0 +1,25 @@
+# Virtual environment
+.venv/
+
+# Python
+__pycache__/
+*.pyc
+*.pyo
+
+# IDE
+.idea/
+.vscode/
+*.swp
+.claude/
+.ruff_cache/
+.mypy_cache/
+*.txt
+test/
+
+# local memory
+.memcord
+.mcp.json
+
+# OS
+.DS_Store
+Thumbs.db

processcaspdf-0.3.1/.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.7
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.14.1
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - pandas-stubs
+          - types-requests

processcaspdf-0.3.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Neeraj Tikku
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

processcaspdf-0.3.1/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.5
+Name: processCASpdf
+Version: 0.3.1
+Summary: Extract data from CAMS Mutual Fund PDF statements
+Project-URL: Homepage, https://github.com/ukkit/processCASpdf
+Project-URL: Repository, https://github.com/ukkit/processCASpdf
+Project-URL: Issues, https://github.com/ukkit/processCASpdf/issues
+Author-email: Neeraj Tikku <neeraj.tikku@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: pandas>=1.3.0
+Requires-Dist: pdfplumber>=0.7.0
+Requires-Dist: requests>=2.25.0
+Description-Content-Type: text/markdown
+
+# Mutual Fund CAS PDF Statement Parser
+
+A Python tool/library that extracts data from Consolidated Account Statement (CAS) PDFs (https://github.com/ukkit/processCASpdf) — tested with KFintech — into CSV, DataFrame, JSON, or a list of dictionaries.
+
+## Requirements
+
+- Python >= 3.9
+- [uv](https://github.com/astral-sh/uv) package manager
+- Internet connection (fetches AMFI scheme data on each run)
+
+## Installation
+
+```bash
+git clone https://github.com/ukkit/processCASpdf.git
+cd processCASpdf
+curl -LsSf https://astral.sh/uv/install.sh | sh
+uv sync
+```
+
+## Usage
+
+```python
+from processCASpdf import ProcessPDF
+
+pdf = ProcessPDF("CAS_statement.pdf", password="your_pdf_password")
+```
+
+- `filename` (required) - Path to the CAS PDF file.
+- `password` (optional) - PDF password (usually your PAN in uppercase).
+
+### Output Formats
+
+Call `get_pdf_data(format)` with one of: `"csv"` (default), `"df"`, `"json"`, `"dicts"`.
+
+```python
+pdf.get_pdf_data("csv")          # writes CAS_data_<timestamp>.csv to current directory
+df  = pdf.get_pdf_data("df")     # returns pandas DataFrame
+js  = pdf.get_pdf_data("json")   # returns JSON string
+rec = pdf.get_pdf_data("dicts")  # returns list of dicts
+```
+
+### Output Fields
+
+| Field | Type | Description |
+|---|---|---|
+| `fund_name` | str | Mutual fund scheme name |
+| `isin` | str | ISIN code (e.g. `INF...`) |
+| `scheme_code` | str | AMFI scheme code; empty if lookup fails |
+| `folio_num` | str | Folio number |
+| `date` | str | Transaction date (e.g. `01-Jan-2025`) |
+| `txn` | str | `Buy` or `Sell` |
+| `amount` | float | Transaction amount (INR) |
+| `units` | float | Units transacted |
+| `nav` | float | NAV at time of transaction |
+| `balance_units` | float | Unit balance after transaction |
+
+### Example
+
+```python
+import logging
+from processCASpdf import ProcessPDF
+
+logging.basicConfig(level=logging.DEBUG)  # optional
+
+pdf = ProcessPDF("MyCAS.pdf", password="ABCDE1234F")
+df = pdf.get_pdf_data("df")
+
+df[df["fund_name"].str.contains("HDFC", case=False)]
+df.to_excel("cas_transactions.xlsx", index=False)
+```
+
+## Troubleshooting
+
+| Problem | Likely cause / fix |
+|---|---|
+| `PDFPasswordIncorrect` | Wrong or missing password. Try your PAN in uppercase. |
+| No transactions extracted | Enable debug logging to inspect raw PDF text. |
+| `scheme_code` is empty | ISIN not found in current AMFI data (new or discontinued scheme). |
+| Network error on startup | AMFI data fetch requires outbound HTTPS. |
+
+## Development
+
+```bash
+uv sync --group dev
+uv run ruff check .
+uv run ruff format .
+uv run mypy processCASpdf.py
+uv run pre-commit install
+```
+
+## Credits
+
+Based on [`camspdf.py`](https://github.com/srbharadwaj/CAMSPdfExtractor) originally written by Suhas Bharadwaj.

processcaspdf-0.3.1/README.md

@@ -0,0 +1,93 @@
+# Mutual Fund CAS PDF Statement Parser
+
+A Python tool/library that extracts data from Consolidated Account Statement (CAS) PDFs (https://github.com/ukkit/processCASpdf) — tested with KFintech — into CSV, DataFrame, JSON, or a list of dictionaries.
+
+## Requirements
+
+- Python >= 3.9
+- [uv](https://github.com/astral-sh/uv) package manager
+- Internet connection (fetches AMFI scheme data on each run)
+
+## Installation
+
+```bash
+git clone https://github.com/ukkit/processCASpdf.git
+cd processCASpdf
+curl -LsSf https://astral.sh/uv/install.sh | sh
+uv sync
+```
+
+## Usage
+
+```python
+from processCASpdf import ProcessPDF
+
+pdf = ProcessPDF("CAS_statement.pdf", password="your_pdf_password")
+```
+
+- `filename` (required) - Path to the CAS PDF file.
+- `password` (optional) - PDF password (usually your PAN in uppercase).
+
+### Output Formats
+
+Call `get_pdf_data(format)` with one of: `"csv"` (default), `"df"`, `"json"`, `"dicts"`.
+
+```python
+pdf.get_pdf_data("csv")          # writes CAS_data_<timestamp>.csv to current directory
+df  = pdf.get_pdf_data("df")     # returns pandas DataFrame
+js  = pdf.get_pdf_data("json")   # returns JSON string
+rec = pdf.get_pdf_data("dicts")  # returns list of dicts
+```
+
+### Output Fields
+
+| Field | Type | Description |
+|---|---|---|
+| `fund_name` | str | Mutual fund scheme name |
+| `isin` | str | ISIN code (e.g. `INF...`) |
+| `scheme_code` | str | AMFI scheme code; empty if lookup fails |
+| `folio_num` | str | Folio number |
+| `date` | str | Transaction date (e.g. `01-Jan-2025`) |
+| `txn` | str | `Buy` or `Sell` |
+| `amount` | float | Transaction amount (INR) |
+| `units` | float | Units transacted |
+| `nav` | float | NAV at time of transaction |
+| `balance_units` | float | Unit balance after transaction |
+
+### Example
+
+```python
+import logging
+from processCASpdf import ProcessPDF
+
+logging.basicConfig(level=logging.DEBUG)  # optional
+
+pdf = ProcessPDF("MyCAS.pdf", password="ABCDE1234F")
+df = pdf.get_pdf_data("df")
+
+df[df["fund_name"].str.contains("HDFC", case=False)]
+df.to_excel("cas_transactions.xlsx", index=False)
+```
+
+## Troubleshooting
+
+| Problem | Likely cause / fix |
+|---|---|
+| `PDFPasswordIncorrect` | Wrong or missing password. Try your PAN in uppercase. |
+| No transactions extracted | Enable debug logging to inspect raw PDF text. |
+| `scheme_code` is empty | ISIN not found in current AMFI data (new or discontinued scheme). |
+| Network error on startup | AMFI data fetch requires outbound HTTPS. |
+
+## Development
+
+```bash
+uv sync --group dev
+uv run ruff check .
+uv run ruff format .
+uv run mypy processCASpdf.py
+uv run pre-commit install
+```
+
+## Credits
+
+Based on [`camspdf.py`](https://github.com/srbharadwaj/CAMSPdfExtractor) originally written by Suhas Bharadwaj.