Skip to content

Commit

Permalink
docs(README): update
Browse files Browse the repository at this point in the history
  • Loading branch information
benjamin-awd committed Nov 24, 2023
1 parent 0e20136 commit ffd0ed4
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ make setup
## Usage
Monopoly can be run as a Python package, allowing you to extract, transform and write bank statements to a CSV file.

To see how Monopoly works, you can run this [example](monopoly/examples/single_statement.py)
To see how Monopoly works, you can run this example
```bash
python3 monopoly/examples/single_statement.py
python3 src/monopoly/examples/single_statement.py
```

If your PDF is encrypted, you'll have to add the password to a .env file in the root directory, which is automatically read by monopoly
Expand All @@ -48,6 +48,6 @@ cp .env.template .env

## Features
- Support for encrypted PDFs -- passwords can be passed in via a .env file, or passed directly via a bank class
- PDFs can also be unlocked with a static string, and a masking pattern like ?d?d?d for banks like HSBC that use a common password prefix (DOB), but different passwords for each card
- Cashback transactions from Citibank and OCBC are also supported, and appear as "negative" transactions
- PDFs can also be unlocked with a static string, and a masking pattern like ?d?d?d for banks like HSBC that use a common password prefix (DOB), but different passwords for each card
- Support for cashback transactions and refunds
- Monopoly can be run on Google Cloud as a scheduled Cloud Run job, which opens up more sophisticated use-cases like historical analysis and personal finance visualization
2 changes: 1 addition & 1 deletion src/monopoly/examples/multiple_statements.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ def ocbc_example():
)
statement = bank.extract()
transformed_df = bank.transform(statement)
bank.load(transformed_df, statement)
bank.load(transformed_df, statement, output_directory="src/monopoly/examples")


if __name__ == "__main__":
Expand Down
5 changes: 2 additions & 3 deletions src/monopoly/examples/single_statement.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,8 @@ def example():
transformed_df = bank.transform(statement)
print(transformed_df)

# Files are saved to an output directory
# monopoly/output/monopoly-credit-2023-08.csv
bank.load(transformed_df, statement)
# Parsed transactions writen to a CSV file in the "example" directory
bank.load(transformed_df, statement, output_directory="src/monopoly/examples")


if __name__ == "__main__":
Expand Down

0 comments on commit ffd0ed4

Please sign in to comment.