Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
tarioch authored Dec 8, 2019
1 parent 42766bd commit a9d4e9e
Showing 1 changed file with 17 additions and 13 deletions.
30 changes: 17 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
==============
beancounttools
.. image:: https://img.shields.io/pypi/l/tariochbctools.svg
:target: https://pypi.python.org/pypi/tariochbctools
.. image:: https://img.shields.io/pypi/v/tariochbctools.svg
:target: https://pypi.python.org/pypi/tariochbctools

tariochbctools
==============


Expand All @@ -11,7 +15,7 @@ plugins

Dynamically generates prices to the base ccy by applying the fx rate to the base ccy for non base ccy prices

.. code:: beancount
::

plugin "tariochbctools.plugins.generate_base_ccy_prices" "CHF"

Expand All @@ -23,7 +27,7 @@ price fetchers
Fetches prices from `Alphavantage <https://www.alphavantage.co/>`_
Requires the environment variable ``ALPHAVANTAGE_API_KEY`` to be set with your personal api key.

.. code:: beancount
::

2019-01-01 commodity VWRL
price: "CHF:tariochbctools.plugins.prices.alphavantage/VWRL.SW"
Expand All @@ -32,7 +36,7 @@ Requires the environment variable ``ALPHAVANTAGE_API_KEY`` to be set with your p

Fetches prices from `Bitstamp <https://www.bitstamp.com/>`_

.. code:: beancount
::

2019-01-01 commodity BTC
price: "EUR:tariochbctools.plugins.prices.bitstamp/BTC"
Expand All @@ -41,7 +45,7 @@ Fetches prices from `Bitstamp <https://www.bitstamp.com/>`_

Fetches prices from `exchangeratesapi.io <https://exchangeratesapi.io//>`_

.. code:: beancount
::

2019-01-01 commodity EUR
price: "CHF:tariochbctools.plugins.prices.exchangeratesapi/EUR"
Expand All @@ -55,7 +59,7 @@ Import transactions from `Bitstamp <https://www.bitstamp.com/>`_

Create a file called bitstamp.yaml in your import location (e.g. downloads folder).

.. code:: yaml
::

username: "12345"
key: "MyKey"
Expand All @@ -68,7 +72,7 @@ Create a file called bitstamp.yaml in your import location (e.g. downloads folde
- eur
- btc

.. code:: python
::

from tariochbctools.importers.bitst import importer as bitstimp
CONFIG = [bitstimp.Importer()]
Expand All @@ -77,7 +81,7 @@ Create a file called bitstamp.yaml in your import location (e.g. downloads folde

Import CSV from `Revolut <https://www.revolut.com/>`_

.. code:: python
::

from tariochbctools.importers.revolut import importer as revolutimp
CONFIG = [revolutimp.Importer('/Revolut-CHF.*\.csv', 'Assets:Revolut:CHF', 'CHF')]
Expand All @@ -86,7 +90,7 @@ Import CSV from `Revolut <https://www.revolut.com/>`_

Import CSV from `Transferwise <https://www.transferwise.com/>`_

.. code:: python
::

from tariochbctools.importers.transferwiseimport importer as twimp
CONFIG = [twimp.Importer('/statement_CHF.*\.csv', 'Assets:Transferwise:CHF')]
Expand All @@ -95,7 +99,7 @@ Import CSV from `Transferwise <https://www.transferwise.com/>`_

Import mt940 from `Zürcher Kantonalbank <https://www.zkb.ch/>`_

.. code:: python
::

from tariochbctools.importers.zkb import importer as zkbimp
CONFIG = [zkbimp.ZkbImporter('/\d+\.mt940', 'Assets:ZKB')]
Expand All @@ -114,7 +118,7 @@ Generate scheduled transactions.

Define a file called schedule.yaml in your import location (e.g. downloads folder). That describes the schedule transactions. They will be added each month at the end of the month.

.. code:: yaml
::

transactions:
- narration: 'Save'
Expand All @@ -125,7 +129,7 @@ Define a file called schedule.yaml in your import location (e.g. downloads folde
- account: 'Assets:Saving'


.. code:: python
::

from tariochbctools.importers.schedule import importer as scheduleimp
CONFIG = [ scheduleimp.Importer() ]
Expand Down

0 comments on commit a9d4e9e

Please sign in to comment.