import2ledger
=============

Introduction
------------

import2ledger provides a Python library and CLI tool to read financial data from various popular sources and generate entries for text-based accounting books from them.

Installation
------------

This is a pretty normal Python module, so if you have a favorite way to install those, it will probably work.  If you just want to install it to run the script locally, try running from the source directory::

  $ python3 -m pip install --user -U --upgrade-strategy only-if-needed .

Configuring import2ledger
-------------------------

Since different organizations follow different accounting rules, you need to define an entry template for each kind of data that you want to be able to import.  You do that in a configuration file.  By default, import2ledger reads a configuration file at ``~/.config/import2ledger.ini``.  You can specify a different path with the ``-C`` option, and you can specify that multiple times to read multiple configuration files in order.

Writing templates
~~~~~~~~~~~~~~~~~

A template looks like a Ledger entry with a couple of differences:

* You don't write the first payee line.
* Instead of writing specific currency amounts, you write simple expressions to calculate amounts.

Here's a simple template for Patreon patron payments::

  [DEFAULT]
  patreon income ledger entry =
    ;Tag: Value
    Income:Patreon  -{amount}
    Accrued:Accounts Receivable:Patreon  {amount}

Let's walk through this line by line.

Every setting in your configuration file has to be in a section.  ``[DEFAULT]`` is the default section, and import2ledger reads configuration settings from here if you don't specify another one.  This documentation explains how to use sections later.

``patreon income ledger entry =`` specifies which entry template this is.  Every template is found from a setting with a name in the pattern ``<SOURCE> <TYPE> ledger entry``.  The remaining lines are indented further than this name; this defines a multiline value.  Don't worry about the exact indentation of your template; import2ledger will indent its output nicely.

The first line of the template is a Ledger tag.  The program will leave all kinds of tags and Ledger comments alone, except to indent them nicely.

The next two lines split the money across accounts.  They follow almost the same format as they do in Ledger: there's an account named, followed by a tab or two or more spaces, and then an expression.  Each time import2ledger generates an entry, it will evaluate this expression using the data it imported to calculate the actual currency amount to write.  Your expression can use numbers, basic arithmetic operators (including parentheses for grouping), and imported data referred to as ``{variable_name}``.

import2ledger uses decimal math to calculate each amount, and rounds to the number of digits appropriate for that currency.  If the amount of currency being imported doesn't split evenly, spare change will be allocated to the last split to keep the entry balanced on both sides.

Refer to the `Python documentation for INI file structure <https://docs.python.org/3/library/configparser.html#supported-ini-file-structure>`_ for full details of the syntax.  Note that import2ledger doesn't use ``;`` as a comment prefix, since that's the primary comment prefix in Ledger.

Template variables
~~~~~~~~~~~~~~~~~~

import2ledger templates have access to a few variables for each transaction that can be included anywhere in the entry, not just amount expressions.  In other parts of the entry, they're treated as strings, and you can control their formatting using `Python's format string syntax <https://docs.python.org/3/library/string.html#formatstrings>`_.  For example, this template customizes the payee line and sets different payees for each side of the transaction::

  template patreon income =
    {date}  Patreon payment from {payee}
    Income:Patreon  -{amount}
    ;Payee: {payee}
    Accrued:Accounts Receivable:Patreon  {amount}
    ;Payee: Patreon

Templates automatically detect whether or not you have a custom payee line by checking if the first line begins with a date variable.  If it does, it's assumed to be your payee line.  Otherwise, the template uses a default payee line of ``{date} {payee}``.

Every template can use the following variables:

================== ==========================================================
Name               Contents
================== ==========================================================
amount             The total amount of the transaction, as a simple decimal
                   number (not currency-formatted)
------------------ ----------------------------------------------------------
currency           The three-letter code for the transaction currency
------------------ ----------------------------------------------------------
date               The date of the transaction, in your configured output
                   format
------------------ ----------------------------------------------------------
payee              The name of the transaction payee
------------------ ----------------------------------------------------------
source_abspath     The absolute path of the file being imported
------------------ ----------------------------------------------------------
source_absdir      The absolute path of the directory that contains the file
                   being imported
------------------ ----------------------------------------------------------
source_dir         The path of the directory that contains the file being
                   imported, as specified on the command line
------------------ ----------------------------------------------------------
source_name        The filename of the file being imported
------------------ ----------------------------------------------------------
source_path        The path of the file being imported, as specified on the
                   command line
------------------ ----------------------------------------------------------
source_stem        The filename of the file being imported, with its
                   extension removed
================== ==========================================================

Specific importers and hooks may provide additional variables.

Supported templates
~~~~~~~~~~~~~~~~~~~

You can define the following templates.

Amazon Affiliate Program
^^^^^^^^^^^^^^^^^^^^^^^^

``amazon earnings ledger entry``
  Imports one transaction per month, summarizing all earnings over the month.  Generated from Amazon's "Fee Earnings" report CSV.

Benevity
^^^^^^^^

``benevity donation ledger entry``
  Imports one transaction per row in Benevity's donations report CSV.

  This template can use these variables:

  ================ ===========================================================
  Name             Contents
  ================ ===========================================================
  comment          The comment from the donor
  ---------------- -----------------------------------------------------------
  corporation      The name of the participating corporation
  ---------------- -----------------------------------------------------------
  disbursement_id  The ID of the dirbursement from Benevity that includes this
                   donation
  ---------------- -----------------------------------------------------------
  donation_amount  The amount donated by the individual donor named
  ---------------- -----------------------------------------------------------
  frequency        The frequency of this donation as indicated in the report
  ---------------- -----------------------------------------------------------
  match_amount     The amount of the donation match by the participating
                   corporation
  ---------------- -----------------------------------------------------------
  project          The Project named in this row
  ---------------- -----------------------------------------------------------
  transaction_id   The ID of this specific donation
  ================ ===========================================================

BrightFunds
^^^^^^^^^^^

``brightfunds donorreport ledger entry``
  Imports one transaction per row in donor report XLS files that BrightFunds mails each month to recipients.

  This template can use these variables:

  ================ ===========================================================
  Name             Contents
  ================ ===========================================================
  company_name     The company name as reported in the spreadsheet
  ---------------- -----------------------------------------------------------
  corporation      The company name as detected by the importer (this is
                   usually what you want)
  ---------------- -----------------------------------------------------------
  donor_name       The donor name as reported in the spreadsheet (usually you
                   want to use ``payee`` instead)
  ---------------- -----------------------------------------------------------
  donor_email      The donor's e-mail address as reported in the spreadsheet
  ---------------- -----------------------------------------------------------
  on_behalf_of     From the corresponding spreadsheet column
  ---------------- -----------------------------------------------------------
  fund             From the corresponding spreadsheet column
  ---------------- -----------------------------------------------------------
  type             From the corresponding spreadsheet column
  ================ ===========================================================

Patreon
^^^^^^^

``patreon income ledger entry``
  Imports one transaction per patron per month.  Generated from Patreon's monthly patron report CSVs.

``patreon cardfees ledger entry``
  Imports one expense transaction per month for that month's credit card fees.  Generated from Patreon's earnings report CSV.

``patreon servicefees ledger entry``
  Imports one expense transaction per month for that month's Patreon service fees.  Generated from Patreon's earnings report CSV.

``patreon vat ledger entry``
  Imports one transaction per country per month each time Patreon withheld VAT.  Generated from Patreon's VAT report CSV.

  This template can use these variables:

  ============== ============================================================
  Name           Contents
  ============== ============================================================
  country_name   The full name of the country VAT was withheld for
  -------------- ------------------------------------------------------------
  country_code   The two-letter ISO country code of the country VAT was
                 withheld for
  ============== ============================================================

Stripe
^^^^^^

``stripe payment ledger entry``
  Imports one transaction per payment.  Generated from Stripe's payments CSV export.

  This template can use these variables:

  ============ ============================================================
  Name         Contents
  ============ ============================================================
  description  The description given to the payment when it was created
  ------------ ------------------------------------------------------------
  fee          The amount of fees charged by Stripe for this payment, as a
               plain decimal number
  ------------ ------------------------------------------------------------
  payment_id   The id assigned to this payment by Stripe
  ------------ ------------------------------------------------------------
  tax          The amount of tax withheld by Stripe for this payment, as a
               plain decimal number
  ============ ============================================================

Other output options
~~~~~~~~~~~~~~~~~~~~

Various options control how import2ledger formats dates and currency amounts.  Run ``import2ledger --help`` for a full list; they're listed under the "default overrides" section.  You can specify these in your configuration file, too.  Just change any dashes (``-``) in the option name to underscores (``_``), and separate the switch name from your value with ``=``.  For example, add this to your configuration file to use ISO 8601-formatted dates in your Ledger entries::

  date_format = %%Y-%%m-%%d

(``%`` is a special character in the configuration file syntax.  ``%%`` represents a literal percent sign.)

Configuration sections
~~~~~~~~~~~~~~~~~~~~~~

If you keep different sets of books, it might be helpful to have different configuration settings for each.  For example, you might adjust the templates for each set of books to use different accounts or tags.  Or you might just need to change the formatting of dates or currency amounts.

import2ledger makes this easy by letting you define a new section of options, and then using them all when you import transactions.  For example, say you keep two sets of books, one for US accounts and another for European accounts.  You could write a configuration file like::

  [us]
  date_format = %%m/%%d/%%Y
  signed_currencies = USD

  [eu]
  date_format = %%d.%%m.%%Y
  signed_currencies = EUR

When you run import2ledger, you can tell it to load options from one of these sections with the option ``--use-config NAME``, or ``-c NAME`` for short.  In this example, ``import2ledger -c eu`` would load the settings for your European books.  import2ledger looks for configuration settings in the following places, and uses the first setting it finds:

1. The configuration section you specify with ``-c``
2. Command-line options
3. The ``[DEFAULT]`` configuration section
4. import2ledger defaults

Running import2ledger
---------------------

Once you've written a configuration file with your templates and any other configuration you need, you can run it with data to import::

  $ import2ledger [options …] file1.csv [file2.csv …]

import2ledger will read all the data sources and generate bookkeeping entries from them.

import2ledger needs to be able to seek within the source files.  Because of that, your input files need to be normal files, or symlinks to them.  Special files like devices and FIFOs aren't supported by import2ledger.

Exit status
~~~~~~~~~~~

import2ledger reports the following exit codes:

========= =================================================================
Exit code Meaning
========= =================================================================
0         Imported data from all source files
--------- -----------------------------------------------------------------
1         Internal error (probably a bug)
--------- -----------------------------------------------------------------
2         Error in the user's settings, such as a formatting error in a
          template or date, or a reference to a nonexistent file or
          configuration file section
--------- -----------------------------------------------------------------
11-99     Failed to import data from at least one source file.  The exit
          code is 10 + the number of files that couldn't be imported, up
          to the maximum exit code of 99.
========= =================================================================