Merge pull request #33 from codereverser/feature/capital-gains-report

generate Capital Gains Report

Author: codereverser

CHANGELOG.md

@@ -1,20 +1,24 @@
 # Changelog
 
+## 0.5.0 - 2021-07-02
+- Support for calculating capital gains from detailed CAS statements
+
+
 ## 0.4.8 - 2021-06-27
 - `REVERSAL` TransactionType to indicate reverted/rejected transactions
 - convert all enums to strEnums for better readability [(#35)](https://github.com/codereverser/casparser/pull/35)
 - fix issue with parsing multi-line transactions
 
 ## 0.4.7 - 2021-06-01
 
-- Minor bug fixes in summary statement parser.
+- Minor bug fixes in summary-statement parser.
 - cli now uses [rich](http://rich.readthedocs.io/) for console output.
-- Dependency management and deployment is handled by poetry.
+- Use poetry for dependency management and deployment.
 - **BREAKING CHANGE**: Table output choices have been removed. 
   `-s/--summary` is a flag and doesn't accept any additional arguments.
 - Support for folios without PAN (#28).
 - add support for new style dividend transactions after IDCW renaming. 
-- improved transaction entry parser. 
+- improved parser for transaction entries. 
 
 ## 0.4.6 - 2021-04-04
 
@@ -97,8 +101,8 @@
 
 ## 0.3.0 - 2020-10-25
 
-- **Breaking Change**: `folios` is a list instead of dict, so that the order is 
- preserved during format conversion to other data types like json.  
+- **Breaking Change**: In order to preserve the order of entries, during format 
+  conversion to other data types like json., `folios` is a list instead of dict.  
 - Added a second parser based on [PyMuPDF](https://github.com/pymupdf/PyMuPDF) / 
 [MuPDF](https://mupdf.com/) - ~15-20x faster compared to pure-python pdfminer.
 - Added AMC detection (accessible via `amc` property of folio)

README.md

@@ -8,6 +8,10 @@
 
 Parse Consolidated Account Statement (CAS) PDF files generated from CAMS/KFINTECH
 
+`casparser` also includes a command line tool with the following analysis tools
+- `summary`- print portfolio summary
+- `gains`- Print capital gains report (summary and detailed) 
+
 
 ## Installation
 ```bash
@@ -118,7 +122,7 @@ Notes:
 casparser also comes with a command-line interface that prints summary of parsed 
 portfolio in a wide variety of formats. 
 
-```bash
+```
 Usage: casparser [-o output_file.json|output_file.csv] [-p password] [-s] [-a] CAS_PDF_FILE
 
   -o, --output FILE               Output file path. Saves the parsed data as json or csv
@@ -129,21 +133,45 @@ Usage: casparser [-o output_file.json|output_file.csv] [-p password] [-s] [-a] C
   -p PASSWORD                     CAS password
   -a, --include-all               Include schemes with zero valuation in the
                                   summary output
-  --sort                          Sort transactions by date
+  -g, --gains                     Generate Capital Gains Report (BETA) [Debt fund indexation not 
+                                  considered]
   --force-pdfminer                Force PDFMiner parser even if MuPDF is
                                   detected
 
   --version                       Show the version and exit.
   -h, --help                      Show this message and exit.
 ``` 
 
+#### CLI examples
+```
+# Print portfolio summary
+casparser /path/to/cas.pdf -p password 
+
+# Print portfolio and capital gains summary
+casparser /path/to/cas.pdf -p password -g
+
+# Save parsed data as a json file
+casparser /path/to/cas.pdf -p password -o pdf_parsed.json
+
+# Save parsed data as a csv file
+casparser /path/to/cas.pdf -p password -o pdf_parsed.csv
+
+# Save capital gains transactions in csv files (pdf_parsed-gains-summary.csv and 
+# pdf_parsed-gains-detailed.csv)
+casparser /path/to/cas.pdf -p password -g -o pdf_parsed.csv
+
+```
+
 **Note:** `casparser cli` supports two special output file formats [-o _file.json_ / _file.csv_]
 1. `json` - complete parsed data is exported in json format (including investor info)
 2. `csv` - Summary info is exported in csv format if the input file is a summary statement or if 
    a summary flag (`-s/--summary`) is passed as argument to the CLI. Otherwise, full 
    transaction history is included in the export. 
+   If `-g` flag is present, two additional files '{basename}-gains-summary.csv', 
+   '{basename}-gains-detailed.csv' are created with the capital-gains data.
 3. any other extension - The summary table is saved in the file. 
 
+
 #### Demo
 
 ![demo](https://raw.githubusercontent.com/codereverser/casparser/main/assets/demo.jpg)

casparser/__init__.py

@@ -1,9 +1,11 @@
 from .parsers import read_cas_pdf
+from .analysis import CapitalGainsReport
 from .types import CASParserDataType
 from .__version__ import __version__
 
 __all__ = [
     "read_cas_pdf",
     "__version__",
     "CASParserDataType",
+    "CapitalGainsReport",
 ]

casparser/analysis/__init__.py

@@ -0,0 +1,3 @@
+from .gains import CapitalGainsReport
+
+__all__ = ["CapitalGainsReport"]