Skip to content

Commit

Permalink
docs: improve example by providing TL;DR
Browse files Browse the repository at this point in the history
  • Loading branch information
Sieboldianus authored and blais committed Dec 17, 2024
1 parent a0fc8ca commit f05f82a
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,40 @@ Here's an example for how you could start with all your files in one directory:
└── US
└── CreditCard
└── ...

## How to run this example

The below steps have been tested with Linux and Windows Subsystem for Linux (WSL1/2).

Clone the example from beangulp and cd into the folder:

```bash
git clone [email protected]:beancount/beangulp.git
cd beangulp/examples
```

Install beangulp and beancount in a `.venv`.

```bash
apt-get install python3-venv # required for virtual env
python3 -m venv .venv # create in subfolder called ".venv"
source ./.venv/bin/activate
pip install beangulp beancount
```

At this stage, make sure you are not installing fava (`pip install beangulp beancount
fava`) because this still has beancount v2.3.6 pinned (if you need fava, install
in a different venv).

Also, if you want to run the example folder fully, including pdf2text extraction,
install the following dependencies for pdftotext:

```bash
apt-get install poppler-utils
```

Now run beancount with the beangulp importer:

```bash
python import.py extract ./Downloads > tmp.beancount
```

0 comments on commit f05f82a

Please sign in to comment.