Skip to content

Commit 6694601

Browse files
committed
Update README
1 parent 5ab8572 commit 6694601

File tree

1 file changed

+34
-16
lines changed

1 file changed

+34
-16
lines changed

README.md

Lines changed: 34 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,28 +11,19 @@ Any Transaction used as a template is removed by the plugin during processing. T
1111

1212
## Installation
1313

14-
Import the plugin however your beancount repository dictates.
14+
### Using pip
1515

16-
The author currently uses this method, as this plugin is not yet set up as a properly-importable Python package:
16+
Use pip to install the package:
1717

1818
```shell
19-
$ grep pythonpath main.beancount
20-
option "insert_pythonpath" "True"
21-
$ grep repete main.beancount
22-
plugin "plugins.beancount-repete.plugin"
23-
$ cd plugins
24-
$ git submodule add https://github.com/jpluscplusm/beancount-repete
25-
Cloning into 'beancount-repete'...
26-
remote: Enumerating objects: 6, done.
27-
remote: Counting objects: 100% (6/6), done.
28-
remote: Compressing objects: 100% (5/5), done.
29-
remote: Total 6 (delta 0), reused 3 (delta 0), pack-reused 0
30-
Receiving objects: 100% (6/6), 12.65 KiB | 762.00 KiB/s, done.
19+
pip install git+https://github.com/jpluscplusm/beancount-repete
3120
```
3221

33-
### Dependencies
22+
Add this line to your beancount file to enable the plugin:
3423

35-
Install the [Recurrent](https://github.com/kvh/recurrent) library. It is available [from PyPI](https://pypi.org/project/recurrent/).
24+
```
25+
plugin "beancount_repete"
26+
```
3627

3728
## Usage
3829

@@ -160,3 +151,30 @@ $ bean-report example.beancount print
160151
```
161152

162153
Note that the original template, on 2022-01-01, is not present in this output. This is always true: if a template's schedule would not generate its original date when evaluated, the template Transaction will not be produced.
154+
155+
156+
## Installation into beancount repository
157+
158+
As an alternative to the default install method, you can copy the files of this plugin directly into the folder of your beancount file. Use the beancount option `insert_pythonpath` in this case. To access a subfolder, prepend it and separate with a dot, like for Python modules.
159+
160+
This is how the setup of the author currently looks like:
161+
162+
```shell
163+
$ grep pythonpath main.beancount
164+
option "insert_pythonpath" "True"
165+
$ grep repete main.beancount
166+
plugin "plugins.beancount-repete"
167+
$ cd plugins
168+
$ git submodule add https://github.com/jpluscplusm/beancount-repete
169+
Cloning into 'beancount-repete'...
170+
remote: Enumerating objects: 6, done.
171+
remote: Counting objects: 100% (6/6), done.
172+
remote: Compressing objects: 100% (5/5), done.
173+
remote: Total 6 (delta 0), reused 3 (delta 0), pack-reused 0
174+
Receiving objects: 100% (6/6), 12.65 KiB | 762.00 KiB/s, done.
175+
```
176+
177+
When using this method, you have to install dependencies manually:
178+
179+
Install the [Recurrent](https://github.com/kvh/recurrent) library. It is available [from PyPI](https://pypi.org/project/recurrent/).
180+

0 commit comments

Comments
 (0)