Skip to content

Commit 33713cf

Browse files
authored
Update README.md
Updated CLI documentation in README
1 parent 753330a commit 33713cf

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
[![GitHub](https://img.shields.io/github/license/codereverser/casparser)](https://github.com/codereverser/casparser/blob/main/LICENSE)
55
[![Travis CI](https://img.shields.io/travis/codereverser/casparser)](https://travis-ci.org/github/codereverser/casparser)
66
[![Codecov](https://img.shields.io/codecov/c/github/codereverser/casparser)](https://codecov.io/gh/codereverser/casparser)
7-
[![DeepSource](https://deepsource.io/gh/codereverser/casparser.svg/?label=active+issues)](https://deepsource.io/gh/codereverser/casparser/?ref=repository-badge)
87
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/casparser)
98

109
Parse Consolidated Account Statement (CAS) PDF files generated from CAMS/KFINTECH
@@ -86,15 +85,24 @@ data = casparser.read_cas_pdf('/path/to/cas/pdf/file.pdf', 'password')
8685

8786
### CLI
8887

88+
casparser also comes with a command-line interface that prints summary of parsed
89+
portfolio in a wide variety of formats.
90+
8991
```bash
90-
Usage: casparser [-o output_file.json] [-p password] [-s] CAS_PDF_FILE
91-
92-
Options:
93-
-o, --output FILE Output file path (json)
94-
-s, --summary Print Summary of transactions parsed.
95-
-p PASSWORD CAS password
96-
--version Show the version and exit.
97-
--help Show this message and exit.
92+
Usage: casparser [-o output_file.json] [-p password] [-s type] [-a] CAS_PDF_FILE
93+
94+
-o, --output FILE Output file path
95+
-s, --summary simple|plain|grid|fancy_grid|html...
96+
Print Summary of transactions parsed.
97+
-p PASSWORD CAS password
98+
-a, --include-all Include schemes with zero valuation in the
99+
summary output
100+
101+
--force-pdfminer Force PDFMiner parser even if MuPDF is
102+
detected
103+
104+
--version Show the version and exit.
105+
-h, --help Show this message and exit.
98106
```
99107
100108
#### Demo
@@ -113,4 +121,4 @@ would apply. Copies of all licenses have been included in this repository. - _IA
113121
1. [CAS from CAMS](https://new.camsonline.com/Investors/Statements/Consolidated-Account-Statement)
114122
2. [CAS from Karvy/Kfintech](https://mfs.kfintech.com/investor/General/ConsolidatedAccountStatement)
115123
116-
PS:- select the detailed statement (including transactions) option
124+
PS:- select the detailed statement (including transactions) option

0 commit comments

Comments
 (0)