update README.md

Author: codereverser

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
@@ -117,7 +121,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
@@ -128,21 +132,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/cli.py

@@ -162,7 +162,7 @@ def print_gains(data, output_file_path=None):
         stcg_total = Decimal(0.0)
         ltcg_taxable_total = Decimal(0.0)
         for row in rows:
-            _, fund, _, _, ltcg, stcg, ltcg_taxable = row
+            _, fund, _, _, ltcg, ltcg_taxable, stcg = row
             ltcg_total += ltcg
             stcg_total += stcg
             ltcg_taxable_total += ltcg_taxable
@@ -223,7 +223,7 @@ def print_gains(data, output_file_path=None):
     is_flag=True,
     help="Include schemes with zero valuation in the summary output",
 )
-@click.option("-g", "--gains", is_flag=True, help="Generate Capital Gains Report")
+@click.option("-g", "--gains", is_flag=True, help="Generate Capital Gains Report (BETA)")
 @click.option(
     "--force-pdfminer", is_flag=True, help="Force PDFMiner parser even if MuPDF is detected"
 )

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "casparser"
-version = "0.4.9-alpha.1"
+version = "0.5.0"
 description = "(Karvy/Kfintech/CAMS) Consolidated Account Statement (CAS) PDF parser"
 authors = ["Sandeep Somasekharan <[email protected]>"]
 homepage = "https://github.com/codereverser/casparser"