ledger-autosync-0.3.5/ 0000755 0001750 0001750 00000000000 13111713303 014145 5 ustar egh egh 0000000 0000000 ledger-autosync-0.3.5/tests/ 0000755 0001750 0001750 00000000000 13111713303 015307 5 ustar egh egh 0000000 0000000 ledger-autosync-0.3.5/tests/__init__.py 0000664 0001750 0001750 00000002075 13102261246 017432 0 ustar egh egh 0000000 0000000 # Copyright (c) 2013-2015 Erik Hetzner
#
# This file is part of ledger-autosync
#
# ledger-autosync is free software: you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# ledger-autosync is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with ledger-autosync. If not, see
# .
from unittest import TestCase
import re
class LedgerTestCase(TestCase):
def assertEqualLedgerPosting(self, a, b, msg=None):
"""Checks that two strings are the same posting. Collapses all space
sequences > len(2)."""
a1 = re.sub(' +', ' ', a)
b1 = re.sub(' +', ' ', b)
return self.assertEqual(a1, b1, msg=msg)
ledger-autosync-0.3.5/tests/test_cli.py 0000644 0001750 0001750 00000012225 13111456643 017504 0 ustar egh egh 0000000 0000000 # Copyright (c) 2013, 2014 Erik Hetzner
#
# This file is part of ledger-autosync
#
# ledger-autosync is free software: you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# ledger-autosync is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with ledger-autosync. If not, see
# .
from __future__ import absolute_import
from ledgerautosync import LedgerAutosyncException
from ledgerautosync.cli import run, find_ledger_file
from ledgerautosync.ledgerwrap import Ledger, LedgerPython, HLedger
from ofxclient.config import OfxConfig
import os.path
import tempfile
import sys
from StringIO import StringIO
from unittest import TestCase
from mock import Mock, call, patch
from nose.plugins.attrib import attr
from nose.tools import raises
class CliTest():
def test_run(self):
config = OfxConfig(os.path.join('fixtures', 'ofxclient.ini'))
acct = config.accounts()[0]
acct.download = Mock(side_effect=lambda *args, **kwargs:
file(os.path.join('fixtures', 'checking.ofx')))
config.accounts = Mock(return_value=[acct])
run(['-l', os.path.join('fixtures', 'empty.lgr')], config)
acct.download.assert_has_calls([call(days=7), call(days=14)])
self.assertEqual(config.accounts.call_count, 1)
def test_run_csv_file(self):
config = OfxConfig(os.path.join('fixtures', 'ofxclient.ini'))
run(['-a', 'Paypal', '-l', os.path.join('fixtures', 'empty.lgr'), os.path.join('fixtures', 'paypal.csv')], config)
def test_filter_account(self):
config = OfxConfig(os.path.join('fixtures', 'ofxclient.ini'))
foo = next(acct for acct in config.accounts()
if acct.description == 'Assets:Savings:Foo')
bar = next(acct for acct in config.accounts()
if acct.description == 'Assets:Checking:Bar')
foo.download = Mock(side_effect=lambda *args, **kwargs:
file(os.path.join('fixtures', 'checking.ofx')))
bar.download = Mock()
config.accounts = Mock(return_value=[foo, bar])
run(['-l', os.path.join('fixtures', 'checking.lgr'),
'-a', 'Assets:Savings:Foo'], config)
foo.download.assert_has_calls([call(days=7)])
bar.download.assert_not_called()
def test_find_ledger_path(self):
os.environ["LEDGER_FILE"] = "/tmp/foo"
self.assertEqual(find_ledger_file(), "/tmp/foo", "Should use LEDGER_FILE to find ledger path.")
(f, tmprcpath) = tempfile.mkstemp(".ledgerrc")
os.close(f) # Who wants to deal with low-level file descriptors?
with open(tmprcpath, 'w') as f:
f.write("--bar foo\n")
f.write("--file /tmp/bar\n")
f.write("--foo bar\n")
self.assertEqual(find_ledger_file(tmprcpath), "/tmp/foo", "Should prefer LEDGER_FILE to --file arg in ledgerrc")
del os.environ["LEDGER_FILE"]
self.assertEqual(find_ledger_file(tmprcpath), "/tmp/bar", "Should parse ledgerrc")
os.unlink(tmprcpath)
@raises(LedgerAutosyncException)
def test_no_ledger_arg(self):
config = OfxConfig(os.path.join('fixtures', 'ofxclient.ini'))
run(['-l', os.path.join('fixtures', 'checking.lgr'),
'-L'], config)
def test_no_ledger(self):
config = OfxConfig(os.path.join('fixtures', 'ofxclient.ini'))
acct = config.accounts()[0]
acct.download = Mock(side_effect=lambda *args, **kwargs:
file(os.path.join('fixtures', 'checking.ofx')))
config.accounts = Mock(return_value=[acct])
with patch('ledgerautosync.cli.find_ledger_file', return_value=None):
with patch('sys.stderr', new_callable=StringIO) as mock_stdout:
run([], config)
self.assertEquals(mock_stdout.getvalue(), 'LEDGER_FILE environment variable not set, and no .ledgerrc file found, and -l argument was not supplied: running with deduplication disabled. All transactions will be printed!')
@attr('hledger')
class TestCliHledger(TestCase, CliTest):
def setUp(self):
self.empty_lgr = HLedger(os.path.join('fixtures', 'empty.lgr'))
self.checking_lgr = HLedger(os.path.join('fixtures', 'checking.lgr'))
@attr('ledger')
class TestCliLedger(TestCase, CliTest):
def setUp(self):
self.empty_lgr = Ledger(os.path.join('fixtures', 'empty.lgr'),
no_pipe=True)
self.checking_lgr = Ledger(os.path.join('fixtures', 'checking.lgr'),
no_pipe=True)
@attr('ledger-python')
class TestCliLedgerPython(TestCase, CliTest):
def setUp(self):
self.empty_lgr = LedgerPython(os.path.join('fixtures', 'empty.lgr'))
self.checking_lgr = LedgerPython(
os.path.join('fixtures', 'checking.lgr'))
ledger-autosync-0.3.5/tests/test_ofx_formatter.py 0000644 0001750 0001750 00000017006 13103772260 021613 0 ustar egh egh 0000000 0000000 # Copyright (c) 2013, 2014 Erik Hetzner
#
# This file is part of ledger-autosync
#
# ledger-autosync is free software: you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# ledger-autosync is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with ledger-autosync. If not, see
# .
from __future__ import absolute_import
from ledgerautosync.converter import OfxConverter
from ledgerautosync.ledgerwrap import Ledger
import os.path
from decimal import Decimal
from ofxparse import OfxParser
from nose.plugins.attrib import attr
from tests import LedgerTestCase
@attr('generic')
class TestOfxConverter(LedgerTestCase):
def test_checking(self):
ofx = OfxParser.parse(file(os.path.join('fixtures', 'checking.ofx')))
converter = OfxConverter(ofx=ofx, name="Foo")
self.assertEqualLedgerPosting(converter.convert(ofx.account.statement.transactions[0]).format(),
"""2011/03/31 DIVIDEND EARNED FOR PERIOD OF 03/01/2011 THROUGH 03/31/2011 ANNUAL PERCENTAGE YIELD EARNED IS 0.05%
; ofxid: 1101.1452687~7.0000486
Foo $0.01
Expenses:Misc -$0.01
""")
self.assertEqualLedgerPosting(converter.convert(ofx.account.statement.transactions[1]).format(),
"""2011/04/05 AUTOMATIC WITHDRAWAL, ELECTRIC BILL WEB(S )
; ofxid: 1101.1452687~7.0000487
Foo -$34.51
Expenses:Misc $34.51
""")
self.assertEqualLedgerPosting(converter.convert(ofx.account.statement.transactions[2]).format(),
"""2011/04/07 RETURNED CHECK FEE, CHECK # 319 FOR $45.33 ON 04/07/11
; ofxid: 1101.1452687~7.0000488
Foo -$25.00
Expenses:Misc $25.00
""")
def test_indent(self):
ofx = OfxParser.parse(file(os.path.join('fixtures', 'checking.ofx')))
converter = OfxConverter(ofx=ofx, name="Foo", indent=4)
# testing indent, so do not use the string collapsing version of assert
self.assertEqual(converter.convert(ofx.account.statement.transactions[0]).format(),
"""2011/03/31 DIVIDEND EARNED FOR PERIOD OF 03/01/2011 THROUGH 03/31/2011 ANNUAL PERCENTAGE YIELD EARNED IS 0.05%
; ofxid: 1101.1452687~7.0000486
Foo $0.01
Expenses:Misc -$0.01
""")
def test_investments(self):
ofx = OfxParser.parse(file(os.path.join('fixtures', 'fidelity.ofx')))
converter = OfxConverter(ofx=ofx, name="Foo")
self.assertEqualLedgerPosting(converter.convert(ofx.account.statement.transactions[0]).format(),
"""2012/07/20 YOU BOUGHT
; ofxid: 7776.01234567890.0123456789020201120120720
Foo 100.00000 INTC @ $25.635000000
Assets:Unknown -$2563.50
""")
# test no payee/memo
self.assertEqualLedgerPosting(converter.convert(ofx.account.statement.transactions[1]).format(),
"""2012/07/27 Foo: buystock
; ofxid: 7776.01234567890.0123456789020901120120727
Foo 128.00000 SDRL @ $39.390900000
Assets:Unknown -$5042.04
""")
def test_dynamic_account(self):
ofx = OfxParser.parse(file(os.path.join('fixtures', 'checking.ofx')))
ledger = Ledger(os.path.join('fixtures', 'checking-dynamic-account.lgr'))
converter = OfxConverter(ofx=ofx, name="Assets:Foo", ledger=ledger)
self.assertEqualLedgerPosting(converter.convert(ofx.account.statement.transactions[1]).format(),
"""2011/04/05 AUTOMATIC WITHDRAWAL, ELECTRIC BILL WEB(S )
; ofxid: 1101.1452687~7.0000487
Assets:Foo -$34.51
Expenses:Bar $34.51
""")
def test_balance_assertion(self):
ofx = OfxParser.parse(file(os.path.join('fixtures', 'checking.ofx')))
ledger = Ledger(os.path.join('fixtures', 'checking.lgr'))
converter = OfxConverter(ofx=ofx, name="Assets:Foo", ledger=ledger)
self.assertEqualLedgerPosting(converter.format_balance(ofx.account.statement),
"""2013/05/25 * --Autosync Balance Assertion
Assets:Foo $0.00 = $100.99
""")
def test_initial_balance(self):
ofx = OfxParser.parse(file(os.path.join('fixtures', 'checking.ofx')))
ledger = Ledger(os.path.join('fixtures', 'checking.lgr'))
converter = OfxConverter(ofx=ofx, name="Assets:Foo", ledger=ledger)
self.assertEqualLedgerPosting(converter.format_initial_balance(ofx.account.statement),
"""2000/01/01 * --Autosync Initial Balance
; ofxid: 1101.1452687~7.autosync_initial
Assets:Foo $160.49
Assets:Equity -$160.49
""")
def test_unknownaccount(self):
ofx = OfxParser.parse(file(os.path.join('fixtures', 'checking.ofx')))
converter = OfxConverter(ofx=ofx, name="Foo",
unknownaccount='Expenses:Unknown')
self.assertEqualLedgerPosting(converter.convert(ofx.account.statement.transactions[0]).format(),
"""2011/03/31 DIVIDEND EARNED FOR PERIOD OF 03/01/2011 THROUGH 03/31/2011 ANNUAL PERCENTAGE YIELD EARNED IS 0.05%
; ofxid: 1101.1452687~7.0000486
Foo $0.01
Expenses:Unknown -$0.01
""")
def test_quote_commodity(self):
ofx = OfxParser.parse(file(os.path.join('fixtures', 'fidelity.ofx')))
converter = OfxConverter(ofx=ofx, name="Foo")
self.assertEqualLedgerPosting(converter.convert(ofx.account.statement.transactions[0]).format(),
"""2012/07/20 YOU BOUGHT
; ofxid: 7776.01234567890.0123456789020201120120720
Foo 100.00000 INTC @ $25.635000000
Assets:Unknown -$2563.50
""")
# Check that txns are parsed.
def test_transfer_txn(self):
ofx = OfxParser.parse(file(os.path.join('fixtures', 'investment_401k.ofx')))
converter = OfxConverter(ofx=ofx, name="Foo",
unknownaccount='Expenses:Unknown')
if len(ofx.account.statement.transactions) > 2:
# older versions of ofxparse would skip these transactions
if hasattr(ofx.account.statement.transactions[2], 'tferaction'):
# unmerged pull request
self.assertEqualLedgerPosting(converter.convert(ofx.account.statement.transactions[2]).format(),
"""2014/06/30 Foo: transfer: out
; ofxid: 1234.12345678.123456-01.3
Foo -9.060702 BAZ @ $21.928764
Transfer $198.69
""")
else:
self.assertEqualLedgerPosting(converter.convert(ofx.account.statement.transactions[2]).format(),
"""2014/06/30 Foo: transfer
; ofxid: 1234.12345678.123456-01.3
Foo -9.060702 BAZ @ $21.928764
Transfer $198.69
""")
def test_position(self):
ofx = OfxParser.parse(file(os.path.join('fixtures', 'cusip.ofx')))
converter = OfxConverter(ofx=ofx, name="Foo", indent=4,
unknownaccount='Expenses:Unknown')
self.assertEqual(converter.format_position(ofx.account.statement.positions[0]),
"""P 2016/10/08 07:30:08 SHSAX 47.8600000
""")
def test_dividend(self):
ofx = OfxParser.parse(file(os.path.join('fixtures', 'income.ofx')))
converter = OfxConverter(ofx=ofx, name="Foo")
self.assertEqualLedgerPosting(converter.convert(ofx.account.statement.transactions[0]).format(),
"""2016/10/12 DIVIDEND RECEIVED
; dividend_from: cusip_redacted
; ofxid: 1234.12345678.123456-01.redacted
Foo $1234.56
Income:Dividends -$1234.56
""")
ledger-autosync-0.3.5/tests/test_weird_ofx.py 0000664 0001750 0001750 00000005270 13053205175 020724 0 ustar egh egh 0000000 0000000 # Copyright (c) 2013, 2014 Erik Hetzner
#
# This file is part of ledger-autosync
#
# ledger-autosync is free software: you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# ledger-autosync is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with ledger-autosync. If not, see
# .
from __future__ import absolute_import
from ledgerautosync.cli import run
from ledgerautosync.converter import OfxConverter
from ledgerautosync.ledgerwrap import Ledger, HLedger, LedgerPython
from ledgerautosync.sync import OfxSynchronizer
from ledgerautosync import EmptyInstitutionException
import os.path
from ofxclient.config import OfxConfig
from unittest import TestCase
from nose.plugins.attrib import attr
from nose.tools import raises
class WeirdOfxTest(object):
@raises(EmptyInstitutionException)
def test_no_institution_no_fid(self):
config = OfxConfig(os.path.join('fixtures', 'ofxclient.ini'))
run([os.path.join('fixtures', 'no-institution.ofx'),
'-l', os.path.join('fixtures', 'empty.lgr'),
'-a', 'Assets:Savings:Foo'], config)
def test_no_institution(self):
ofxpath = os.path.join('fixtures', 'no-institution.ofx')
OfxSynchronizer(self.lgr).parse_file(ofxpath)
@raises(EmptyInstitutionException)
def test_no_institution_no_accountname(self):
ofxpath = os.path.join('fixtures', 'no-institution.ofx')
(ofx, txns) = OfxSynchronizer(self.lgr).parse_file(ofxpath)
OfxConverter(ofx, name=None)
def test_apostrophe(self):
ofxpath = os.path.join('fixtures', 'apostrophe.ofx')
OfxSynchronizer(self.lgr).parse_file(ofxpath)
def test_one_settleDate(self):
ofxpath = os.path.join('fixtures', 'fidelity-one-dtsettle.ofx')
OfxSynchronizer(self.lgr).parse_file(ofxpath)
@attr('hledger')
class TestWeirdOfxHledger(TestCase, WeirdOfxTest):
def setUp(self):
self.lgr = HLedger(os.path.join('fixtures', 'empty.lgr'))
@attr('ledger')
class TestWeirdOfxLedger(TestCase, WeirdOfxTest):
def setUp(self):
self.lgr = Ledger(os.path.join('fixtures', 'empty.lgr'), no_pipe=True)
@attr('ledger-python')
class TestWeirdOfxLedgerPython(TestCase, WeirdOfxTest):
def setUp(self):
self.lgr = LedgerPython(os.path.join('fixtures', 'empty.lgr'))
ledger-autosync-0.3.5/tests/test_sync.py 0000664 0001750 0001750 00000007612 13110111201 017670 0 ustar egh egh 0000000 0000000 # Copyright (c) 2013, 2014 Erik Hetzner
#
# This file is part of ledger-autosync
#
# ledger-autosync is free software: you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# ledger-autosync is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with ledger-autosync. If not, see
# .
from __future__ import absolute_import
import os
import os.path
from ofxparse import OfxParser
from ledgerautosync.ledgerwrap import Ledger
from ledgerautosync.sync import OfxSynchronizer, CsvSynchronizer
from unittest import TestCase
from nose.plugins.attrib import attr
from mock import Mock
@attr('generic')
class TestOfxSync(TestCase):
def test_fresh_sync(self):
ledger = Ledger(os.path.join('fixtures', 'empty.lgr'))
sync = OfxSynchronizer(ledger)
ofx = OfxParser.parse(file(os.path.join('fixtures', 'checking.ofx')))
txns1 = ofx.account.statement.transactions
txns2 = sync.filter(ofx)
self.assertEqual(txns1, txns2)
def test_sync_order(self):
ledger = Ledger(os.path.join('fixtures', 'empty.lgr'))
sync = OfxSynchronizer(ledger)
ofx = OfxParser.parse(file(os.path.join('fixtures', 'checking_order.ofx')))
txns = sync.filter(ofx)
self.assertTrue(txns[0].date < txns[1].date and
txns[1].date < txns[2].date)
def test_fully_synced(self):
ledger = Ledger(os.path.join('fixtures', 'checking.lgr'))
sync = OfxSynchronizer(ledger)
(ofx, txns) = sync.parse_file(os.path.join('fixtures', 'checking.ofx'))
self.assertEqual(txns, [])
def test_partial_sync(self):
ledger = Ledger(os.path.join('fixtures', 'checking-partial.lgr'))
sync = OfxSynchronizer(ledger)
(ofx, txns) = sync.parse_file(os.path.join('fixtures', 'checking.ofx'))
self.assertEqual(len(txns), 1)
def test_no_new_txns(self):
ledger = Ledger(os.path.join('fixtures', 'checking.lgr'))
acct = Mock()
acct.download = Mock(return_value=file(os.path.join('fixtures', 'checking.ofx')))
sync = OfxSynchronizer(ledger)
self.assertEqual(len(sync.get_new_txns(acct, 7, 7)[1]), 0)
def test_all_new_txns(self):
ledger = Ledger(os.path.join('fixtures', 'empty.lgr'))
acct = Mock()
acct.download = Mock(return_value=file(os.path.join('fixtures', 'checking.ofx')))
sync = OfxSynchronizer(ledger)
self.assertEqual(len(sync.get_new_txns(acct, 7, 7)[1]), 3)
def test_comment_txns(self):
ledger = Ledger(os.path.join('fixtures', 'empty.lgr'))
sync = OfxSynchronizer(ledger)
(ofx, txns) = sync.parse_file(os.path.join('fixtures', 'comments.ofx'))
self.assertEqual(len(txns), 1)
def test_sync_no_ledger(self):
acct = Mock()
acct.download = Mock(return_value=file(os.path.join('fixtures', 'checking.ofx')))
sync = OfxSynchronizer(None)
self.assertEqual(len(sync.get_new_txns(acct, 7, 7)[1]), 3)
@attr('generic')
class TestCsvSync(TestCase):
def test_fresh_sync(self):
ledger = Ledger(os.path.join('fixtures', 'empty.lgr'))
sync = CsvSynchronizer(ledger)
self.assertEqual(
2, len(sync.parse_file(
os.path.join('fixtures', 'paypal.csv'))))
def test_partial_sync(self):
ledger = Ledger(os.path.join('fixtures', 'paypal.lgr'))
sync = CsvSynchronizer(ledger)
self.assertEqual(
1, len(sync.parse_file(
os.path.join('fixtures', 'paypal.csv'))))
ledger-autosync-0.3.5/tests/test_ledger.py 0000644 0001750 0001750 00000007467 13100002404 020167 0 ustar egh egh 0000000 0000000 # Copyright (c) 2013, 2014 Erik Hetzner
#
# This file is part of ledger-autosync
#
# ledger-autosync is free software: you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# ledger-autosync is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with ledger-autosync. If not, see
# .
from __future__ import absolute_import
from ledgerautosync.ledgerwrap import Ledger, HLedger, LedgerPython
from nose.plugins.attrib import attr
from unittest import TestCase
import os
import os.path
import tempfile
class LedgerTest(object):
ledger_path = os.path.join('fixtures', 'checking.lgr')
dynamic_ledger_path = os.path.join('fixtures', 'checking-dynamic-account.lgr')
def check_transaction(self):
self.assertTrue(self.lgr.check_transaction_by_id("ofxid", "1101.1452687~7.0000486"))
def test_nonexistent_transaction(self):
self.assertFalse(self.lgr.check_transaction_by_id("ofxid", "FOO"))
def test_empty_transaction(self):
self.assertTrue(self.lgr.check_transaction_by_id("ofxid", "empty"))
def test_get_account_by_payee(self):
account = self.lgr.get_account_by_payee("AUTOMATIC WITHDRAWAL, ELECTRIC BILL WEB(S )", exclude="Assets:Foo")
self.assertEqual(account, "Expenses:Bar")
def test_get_ambiguous_account_by_payee(self):
account = self.dynamic_lgr.get_account_by_payee("Generic", exclude="Assets:Foo")
# shoud use the latest
self.assertEqual(account, "Expenses:Bar")
def test_ofx_payee_quoting(self):
payees = ['PAYEE TEST/SLASH',
'PAYEE TEST,COMMA',
'PAYEE TEST:COLON',
'PAYEE TEST*STAR',
'PAYEE TEST#HASH',
'PAYEE TEST"QUOTE',
'PAYEE TEST.PERIOD']
for payee in payees:
self.assertNotEqual(self.lgr.get_account_by_payee(payee, ['Assets:Foo']), None,
msg="Did not find %s in %s" % (payee, self.lgr))
def test_ofx_id_quoting(self):
self.assertEqual(self.lgr.check_transaction_by_id("ofxid", "1/2"), True,
msg="Did not find 1/2 in %s" % (self.lgr))
def test_load_payees(self):
self.lgr.load_payees()
self.assertEqual(self.lgr.payees['PAYEE TEST:COLON'], ['Assets:Foo', 'Income:Bar'])
@attr('hledger')
class TestHledger(TestCase, LedgerTest):
def setUp(self):
self.lgr = HLedger(self.ledger_path)
self.dynamic_lgr = HLedger(self.dynamic_ledger_path)
@attr('ledger')
class TestLedger(LedgerTest, TestCase):
def setUp(self):
self.lgr = Ledger(self.ledger_path, no_pipe=True)
self.dynamic_lgr = Ledger(self.dynamic_ledger_path, no_pipe=True)
def test_args_only(self):
(f, tmprcpath) = tempfile.mkstemp(".ledgerrc")
os.close(f) # Who wants to deal with low-level file descriptors?
# Create an init file that will narrow the test data to a period that contains no trasnactions
with open(tmprcpath, 'w') as f:
f.write("--period 2012")
# If the command returns no trasnactions, as we would expect if we
# parsed the init file, then this will throw an exception.
self.lgr.run([""]).next()
os.unlink(tmprcpath)
@attr('ledger-python')
class TestLedgerPython(TestCase, LedgerTest):
def setUp(self):
self.lgr = LedgerPython(self.ledger_path)
self.dynamic_lgr = LedgerPython(self.dynamic_ledger_path)
ledger-autosync-0.3.5/tests/test_converter.py 0000644 0001750 0001750 00000013006 13103772260 020737 0 ustar egh egh 0000000 0000000 # Copyright (c) 2013-2016 Erik Hetzner
#
# This file is part of ledger-autosync
#
# ledger-autosync is free software: you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# ledger-autosync is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with ledger-autosync. If not, see
# .
from __future__ import absolute_import
from ledgerautosync.converter import Converter, CsvConverter, AmazonConverter, MintConverter, PaypalConverter, Amount, Posting
from decimal import Decimal
import hashlib
import csv
from nose.plugins.attrib import attr
from tests import LedgerTestCase
@attr('generic')
class TestPosting(LedgerTestCase):
def test_format(self):
self.assertRegexpMatches(
Posting(
"Foo",
Amount(Decimal("10.00"), "$")
).format(indent=2),
r'^ Foo.*$')
@attr('generic')
class TestAmount(LedgerTestCase):
def test_amount(self):
self.assertEqual(
"$10.00",
Amount(Decimal("10.001"), "$").format(),
"Formats to 2 points precision by default")
self.assertEqual(
"10.00 USD",
Amount(Decimal(10), "USD").format(),
"Longer commodity names come after")
self.assertEqual(
"-$10.00",
Amount(Decimal(10), "$", reverse=True).format(),
"Reverse flag works.")
self.assertEqual(
"10.00 \"ABC123\"",
Amount(Decimal(10), "ABC123").format(),
"Currencies with numbers are quoted")
self.assertEqual(
"10.00 \"A BC\"",
Amount(Decimal(10), "A BC").format(),
"Currencies with whitespace are quoted")
self.assertEqual(
"$10.001",
Amount(Decimal("10.001"), "$", unlimited=True).format())
@attr('generic')
class TestCsvConverter(LedgerTestCase):
def test_get_csv_id(self):
converter = CsvConverter(None)
h = {'foo': 'bar', 'bar': 'foo'}
self.assertEqual(converter.get_csv_id(h),
hashlib.md5("bar=foo\nfoo=bar\n").hexdigest())
@attr('generic')
class TestPaypalConverter(LedgerTestCase):
def test_format(self):
with open('fixtures/paypal.csv', 'rb') as f:
dialect = csv.Sniffer().sniff(f.read(1024))
f.seek(0)
dialect.skipinitialspace = True
reader = csv.DictReader(f, dialect=dialect)
converter = CsvConverter.make_converter(reader, name='Foo')
self.assertEqual(type(converter), PaypalConverter)
self.assertEqual(
converter.convert(reader.next()).format(),
"""2016/06/04 Jane Doe someone@example.net My Friend ID: XYZ1, Recurring Payment Sent
; csvid: paypal.XYZ1
Foo -20.00 USD
Expenses:Misc 20.00 USD
""")
self.assertEqual(
converter.convert(reader.next()).format(),
"""2016/06/04 Debit Card ID: XYZ2, Charge From Debit Card
; csvid: paypal.XYZ2
Foo 20.00 USD
Transfer:Paypal -20.00 USD
""")
@attr('generic')
class TestAmazonConverter(LedgerTestCase):
def test_format(self):
with open('fixtures/amazon.csv', 'rb') as f:
dialect = csv.Sniffer().sniff(f.read(1024))
f.seek(0)
dialect.skipinitialspace = True
reader = csv.DictReader(f, dialect=dialect)
converter = CsvConverter.make_converter(reader, name='Foo')
self.assertEqual(type(converter), AmazonConverter)
self.assertEqual(
converter.convert(reader.next()).format(),
"""2016/01/29 Best Soap Ever
; url: https://www.amazon.com/gp/css/summary/print.html/ref=od_aui_print_invoice?ie=UTF8&orderID=123-4567890-1234567
; csvid: amazon.123-4567890-1234567
Foo $21.90
Expenses:Misc -$21.90
""")
@attr('generic')
class TestMintConverter(LedgerTestCase):
def test_format(self):
with open('fixtures/mint.csv', 'rb') as f:
dialect = csv.Sniffer().sniff(f.read(1024))
f.seek(0)
dialect.skipinitialspace = True
reader = csv.DictReader(f, dialect=dialect)
converter = CsvConverter.make_converter(reader)
self.assertEqual(type(converter), MintConverter)
self.assertEqual(
converter.convert(reader.next()).format(),
"""2016/08/02 Amazon
; csvid: mint.a7c028a73d76956453dab634e8e5bdc1
1234 $29.99
Expenses:Shopping -$29.99
""")
self.assertEqual(
converter.convert(reader.next()).format(),
"""2016/06/02 Autopay Rautopay Auto
; csvid: mint.a404e70594502dd62bfc6f15d80b7cd7
1234 -$123.45
Credit Card Payment $123.45
""")
ledger-autosync-0.3.5/README.rst 0000644 0001750 0001750 00000025576 13103772260 015663 0 ustar egh egh 0000000 0000000 ledger-autosync
===============
ledger-autosync is a program to pull down transactions from your bank
and create `ledger `__ transactions for them. It
is designed to only create transactions that are not already present in
your ledger files (that is, deduplicate transactions). This should make
it comparable to some of the automated synchronization features
available in products like GnuCash, Mint, etc. In fact, ledger-autosync
performs OFX import and synchronization better than all the alternatives
I have seen.
Features
--------
- supports `ledger `__ 3 and
`hledger `__
- like ledger, ledger-autosync will never modify your files directly
- interactive banking setup via
`ofxclient `__
- multiple banks and accounts
- support for non-US currencies
- support for 401k and investment accounts
- tracks investments by share, not dollar value
- support for complex transaction types, including transfers, buys,
sells, etc.
- import of downloaded OFX files, for banks not supporting automatic
download
- import of downloaded CSV files from Paypal, Amazon and Mint
Platforms
---------
ledger-autosync is developed on Linux with ledger 3 and python 2.7; it has been
tested on Windows (although it will run slower) and should run on OS X. It
requires ledger 3 or hledger, but it should run faster with ledger, because it
will not need to start a command to check every transaction.
Quickstart
----------
Installation
~~~~~~~~~~~~
If you are on Debian or Ubuntu, an (older) version of ledger-autosync
should be available for installation. Try:
::
$ sudo apt-get install ledger-autosync
If you use pip, you can install the latest released version:
::
$ pip install ledger-autosync
You can also install from source, if you have downloaded the source:
::
$ python setup.py install
You may need to install the following libraries (on debian/ubuntu):
::
$ sudo apt-get install libffi-dev libpython-dev libssl-dev libxml2-dev python-pip libxslt-dev
Running
~~~~~~~
Once you have ledger-autosync installed, you can download an OFX file
from your bank and run ledger-autosync against it:
::
$ ledger-autosync download.ofx
This should print a number of transactions to stdout. If you add these
transactions to your default ledger file (whatever is read when you run
``ledger`` without arguments), you should find that if you run
ledger-autosync again, it should print no transactions. This is because
of the deduplicating feature: only new transactions should be printed
for insertion into your ledger files.
Using the ofx protocol for automatic download
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ledger-autosync also supports using the OFX protocol to automatically
connect to banks and download data. You can use the ofxclient program
(which should have been installed with ledger-autosync) to set up
banking:
::
$ ofxclient
When you have added your institution, quit ofxclient.
(At least one user has reported being signed up for a pay service by
setting up OFX direct connect. Although this seems unusual, please be
aware of this.)
Edit the generated ``~/ofxclient.ini`` file. Change the ``description``
field of your accounts to the name used in ledger. Optionally, move the
``~/ofxclient.ini`` file to your ``~/.config`` directory.
Run:
::
ledger-autosync
This will download a maximum of 90 days previous activity from your
accounts. The output will be in ledger format and printed to stdout. Add
this output to your ledger file. When that is done, you can call:
::
ledger-autosync
again, and it should print nothing to stdout, because you already have
those transactions in your ledger.
Syncing a file
--------------
Some banks allow users to download OFX files, but do not support
fetching via the OFX protocol. If you have an OFX file, you can convert
to ledger:
::
ledger-autosync /path/to/file.ofx
This will print unknown transactions in the file to stdout in the same
way as ordinary sync. If the transaction is already in your ledger, it
will be ignored.
How it works
------------
ledger-autosync stores a unique identifier, (for OFX files, this is a
unique ID provided by your institution for each transaction), as
metadata in each transaction. When syncing with your bank, it will check
if the transaction exists by running the ledger or hledger command. If
the transaction exists, it does nothing. If it does not exist, the
transaction is printed to stdout.
Syncing a CSV file
------------------
If you have a CSV file, you may also be able to import it using a recent
(installed via source) version of ledger-autosync. ledger-autosync can
currently process CSV files as provided by Paypal, Amazon, or Mint. You
can process the CSV file as follows:
::
ledger-autosync /path/to/file.csv -a Assets:Paypal
With Amazon and Paypal CSV files, each row includes a unique identifier,
so ledger-autosync will be able to deduplicate against any previously
imported entries in your ledger files.
With Mint, a unique identifier based on the data in the row is generated
and stored. If future downloads contain identical rows, they will be
deduplicated. This method is probably not as robust as a method based on
unique ids, but Mint does not provide a unique id, and it should be
better than nothing. It is likely to generate false negatives:
transactions that seem new, but are in fact old. It will not generate
false negatives: transactions that are not generated because they seem
old.
If you are a developer, you should fine it easy enough to add a new CSV
format to ledger-autosync. See, for example, the ``MintConverter`` class
in the ``ledgerautosync/converter.py`` file in this repository.
Assertions
----------
If you supply the ``--assertions`` flag, ledger-autosync will also print
out valid ledger assertions based on your bank balances at the time of
the sync. These otherwise empty transactions tell ledger that your
balance *should* be something at a given time, and if not, ledger will
fail with an error.
401k and investment accounts
----------------------------
If you have a 401k account, ledger-autosync can help you to track the
state of it. You will need OFX files (or an OFX protocol connection as
set up by ofxclient) provided by your 401k.
In general, your 401k account will consist of buy transactions,
transfers and reinvestments. The type will be printed in the payee line
after a colon (``:``)
The buy transactions are your contributions to the 401k. These will be
printed as follows:
::
2016/01/29 401k: buymf
; ofxid: 1234
Assets:Retirement:401k 1.12345 FOOBAR @ $123.123456
Income:Salary -$138.32
This means that you bought (contributed) $138.32 worth of FOOBAR (your
investment fund) at the price of $123.123456. The money to buy the
investment came from your income. In ledger-autosync, the
``Assets:Retirement:401k`` account is the one specified using the
``--account`` command line, or configured in your ``ofxclient.ini``. The
``Income:Salary`` is specified by the ``--unknown-account`` option.
If the transaction is a “transfer” transaction, this usually means
either a fee or a change in your investment option:
::
2014/06/30 401k: transfer: out
; ofxid: 1234
Assets:Retirement:401k -1.61374 FOOBAR @ $123.123456
Transfer $198.69
You will need to examine your statements to determine if this was a fee
or a real transfer back into your 401k.
Another type of transaction is a “reinvest” transaction:
::
2014/06/30 401k: reinvest
; ofxid: 1234
Assets:Retirement:401k 0.060702 FOOBAR @ $123.123456
Income:Interest -$7.47
This probably indicates a reinvestment of dividends. ledger-autosync
will print ``Income:Interest`` as the other account.
resync
------
By default, ledger-autosync will process transactions backwards, and
stop when it sees a transaction that is already in ledger. To force it
to process all transactions up to the ``--max`` days back in time
(default: 90), use the ``--resync`` option. This can be useful when
increasing the ``--max`` option. For instance, if you previously
synchronized 90 days and now want to get 180 days of transactions,
ledger-autosync would stop before going back to 180 days without the
``--resync`` option.
python bindings
---------------
If the ledger python bindings are available, ledger-autosync can use them if you
pass in the ``--python`` argument.Note, however, they can be buggy, which is why
they are disabled by default
Plugin support (Experimental)
-----------------------------
ledger-autosync has experimental support for plugins. By placing python files a
directory named ``~/.config/ledger-autosync/plugins/`` it should be possible to
automatically load python files from there. This allows you to extend the csv
converters with your own code. For example, given the input CSV file:
::
"Date","Name","Amount","Balance"
"11/30/2016","Dividend","$1.06","$1,000“
The following converter in the file ``~/.config/ledger-autosync/plugins/my.py``:
::
from ledgerautosync.converter import CsvConverter, Posting, Transaction, Amount
import datetime
import re
class SomeConverter(CsvConverter):
FIELDSET = set(["Date", "Name", Amount", "Balance"])
def __init__(self, *args, **kwargs):
super(SomeConverter, self).__init__(*args, **kwargs)
def convert(self, row):
md = re.match(r"^(\(?)\$([0-9,\.]+)", row['Amount'])
amount = md.group(2).replace(",", "")
if md.group(1) == "(":
reverse = True
else:
reverse = False
if reverse:
account = 'expenses'
else:
account = 'income'
return Transaction(
date=datetime.datetime.strptime(row['Date'], "%m/%d/%Y"),
payee=row['Name'],
postings=[Posting(self.name, Amount(amount, '$', reverse=reverse)),
Posting(account, Amount(amount, '$', reverse=not(reverse)))])
Running ``ledger-autosync file.csv -a assets:bank`` will generate:
::
2016/11/30 Dividend
assets:bank $1.06
income -$1.06
For more examples, see
https://gitlab.com/egh/ledger-autosync/blob/master/ledgerautosync/converter.py#L421
Testing
-------
ledger-autosync uses nose for tests. To test, run nosetests in the
project directory. This will test the ledger, hledger and ledger-python
interfaces. To test a single interface, use nosetests -a hledger. To
test the generic code, use nosetests -a generic. To test both, use
nosetests -a generic -a hledger. For some reason nosetests -a '!hledger'
will not work.
ledger-autosync-0.3.5/setup.py 0000644 0001750 0001750 00000003200 13111712637 015663 0 ustar egh egh 0000000 0000000 # Always prefer setuptools over distutils
from setuptools import setup, find_packages
# To use a consistent encoding
from codecs import open
from os import path
here = path.abspath(path.dirname(__file__))
# Get the long description from the README file
with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
long_description = f.read()
setup(
name='ledger-autosync',
version="0.3.5",
description="Automatically sync your bank's data with ledger",
long_description=long_description,
author='Erik Hetzner',
author_email='egh@e6h.org',
url='https://gitlab.com/egh/ledger-autosync',
license='GPLv3',
classifiers=[
'Development Status :: 5 - Production/Stable',
'Intended Audience :: End Users/Desktop',
'License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)',
'Operating System :: OS Independent',
'Programming Language :: Python :: 2.7',
'Topic :: Office/Business :: Financial :: Accounting',
'Topic :: Office/Business :: Financial :: Investment',
'Topic :: Office/Business :: Financial'
],
keywords='ledger accounting',
packages=find_packages(exclude=['contrib', 'docs', 'tests']),
install_requires=[
'setuptools>=26',
'ofxclient',
'ofxparse>=0.14',
'BeautifulSoup4',
'fuzzywuzzy'
],
extras_require={
'test': ['nose>=1.0', 'mock']
},
entry_points={
'console_scripts': [
'ledger-autosync = ledgerautosync.cli:run',
'hledger-autosync = ledgerautosync.cli:run'
]
},
test_suite = 'nose.collector'
)
ledger-autosync-0.3.5/PKG-INFO 0000644 0001750 0001750 00000034241 13111713303 015246 0 ustar egh egh 0000000 0000000 Metadata-Version: 1.1
Name: ledger-autosync
Version: 0.3.5
Summary: Automatically sync your bank's data with ledger
Home-page: https://gitlab.com/egh/ledger-autosync
Author: Erik Hetzner
Author-email: egh@e6h.org
License: GPLv3
Description: ledger-autosync
===============
ledger-autosync is a program to pull down transactions from your bank
and create `ledger `__ transactions for them. It
is designed to only create transactions that are not already present in
your ledger files (that is, deduplicate transactions). This should make
it comparable to some of the automated synchronization features
available in products like GnuCash, Mint, etc. In fact, ledger-autosync
performs OFX import and synchronization better than all the alternatives
I have seen.
Features
--------
- supports `ledger `__ 3 and
`hledger `__
- like ledger, ledger-autosync will never modify your files directly
- interactive banking setup via
`ofxclient `__
- multiple banks and accounts
- support for non-US currencies
- support for 401k and investment accounts
- tracks investments by share, not dollar value
- support for complex transaction types, including transfers, buys,
sells, etc.
- import of downloaded OFX files, for banks not supporting automatic
download
- import of downloaded CSV files from Paypal, Amazon and Mint
Platforms
---------
ledger-autosync is developed on Linux with ledger 3 and python 2.7; it has been
tested on Windows (although it will run slower) and should run on OS X. It
requires ledger 3 or hledger, but it should run faster with ledger, because it
will not need to start a command to check every transaction.
Quickstart
----------
Installation
~~~~~~~~~~~~
If you are on Debian or Ubuntu, an (older) version of ledger-autosync
should be available for installation. Try:
::
$ sudo apt-get install ledger-autosync
If you use pip, you can install the latest released version:
::
$ pip install ledger-autosync
You can also install from source, if you have downloaded the source:
::
$ python setup.py install
You may need to install the following libraries (on debian/ubuntu):
::
$ sudo apt-get install libffi-dev libpython-dev libssl-dev libxml2-dev python-pip libxslt-dev
Running
~~~~~~~
Once you have ledger-autosync installed, you can download an OFX file
from your bank and run ledger-autosync against it:
::
$ ledger-autosync download.ofx
This should print a number of transactions to stdout. If you add these
transactions to your default ledger file (whatever is read when you run
``ledger`` without arguments), you should find that if you run
ledger-autosync again, it should print no transactions. This is because
of the deduplicating feature: only new transactions should be printed
for insertion into your ledger files.
Using the ofx protocol for automatic download
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ledger-autosync also supports using the OFX protocol to automatically
connect to banks and download data. You can use the ofxclient program
(which should have been installed with ledger-autosync) to set up
banking:
::
$ ofxclient
When you have added your institution, quit ofxclient.
(At least one user has reported being signed up for a pay service by
setting up OFX direct connect. Although this seems unusual, please be
aware of this.)
Edit the generated ``~/ofxclient.ini`` file. Change the ``description``
field of your accounts to the name used in ledger. Optionally, move the
``~/ofxclient.ini`` file to your ``~/.config`` directory.
Run:
::
ledger-autosync
This will download a maximum of 90 days previous activity from your
accounts. The output will be in ledger format and printed to stdout. Add
this output to your ledger file. When that is done, you can call:
::
ledger-autosync
again, and it should print nothing to stdout, because you already have
those transactions in your ledger.
Syncing a file
--------------
Some banks allow users to download OFX files, but do not support
fetching via the OFX protocol. If you have an OFX file, you can convert
to ledger:
::
ledger-autosync /path/to/file.ofx
This will print unknown transactions in the file to stdout in the same
way as ordinary sync. If the transaction is already in your ledger, it
will be ignored.
How it works
------------
ledger-autosync stores a unique identifier, (for OFX files, this is a
unique ID provided by your institution for each transaction), as
metadata in each transaction. When syncing with your bank, it will check
if the transaction exists by running the ledger or hledger command. If
the transaction exists, it does nothing. If it does not exist, the
transaction is printed to stdout.
Syncing a CSV file
------------------
If you have a CSV file, you may also be able to import it using a recent
(installed via source) version of ledger-autosync. ledger-autosync can
currently process CSV files as provided by Paypal, Amazon, or Mint. You
can process the CSV file as follows:
::
ledger-autosync /path/to/file.csv -a Assets:Paypal
With Amazon and Paypal CSV files, each row includes a unique identifier,
so ledger-autosync will be able to deduplicate against any previously
imported entries in your ledger files.
With Mint, a unique identifier based on the data in the row is generated
and stored. If future downloads contain identical rows, they will be
deduplicated. This method is probably not as robust as a method based on
unique ids, but Mint does not provide a unique id, and it should be
better than nothing. It is likely to generate false negatives:
transactions that seem new, but are in fact old. It will not generate
false negatives: transactions that are not generated because they seem
old.
If you are a developer, you should fine it easy enough to add a new CSV
format to ledger-autosync. See, for example, the ``MintConverter`` class
in the ``ledgerautosync/converter.py`` file in this repository.
Assertions
----------
If you supply the ``--assertions`` flag, ledger-autosync will also print
out valid ledger assertions based on your bank balances at the time of
the sync. These otherwise empty transactions tell ledger that your
balance *should* be something at a given time, and if not, ledger will
fail with an error.
401k and investment accounts
----------------------------
If you have a 401k account, ledger-autosync can help you to track the
state of it. You will need OFX files (or an OFX protocol connection as
set up by ofxclient) provided by your 401k.
In general, your 401k account will consist of buy transactions,
transfers and reinvestments. The type will be printed in the payee line
after a colon (``:``)
The buy transactions are your contributions to the 401k. These will be
printed as follows:
::
2016/01/29 401k: buymf
; ofxid: 1234
Assets:Retirement:401k 1.12345 FOOBAR @ $123.123456
Income:Salary -$138.32
This means that you bought (contributed) $138.32 worth of FOOBAR (your
investment fund) at the price of $123.123456. The money to buy the
investment came from your income. In ledger-autosync, the
``Assets:Retirement:401k`` account is the one specified using the
``--account`` command line, or configured in your ``ofxclient.ini``. The
``Income:Salary`` is specified by the ``--unknown-account`` option.
If the transaction is a “transfer” transaction, this usually means
either a fee or a change in your investment option:
::
2014/06/30 401k: transfer: out
; ofxid: 1234
Assets:Retirement:401k -1.61374 FOOBAR @ $123.123456
Transfer $198.69
You will need to examine your statements to determine if this was a fee
or a real transfer back into your 401k.
Another type of transaction is a “reinvest” transaction:
::
2014/06/30 401k: reinvest
; ofxid: 1234
Assets:Retirement:401k 0.060702 FOOBAR @ $123.123456
Income:Interest -$7.47
This probably indicates a reinvestment of dividends. ledger-autosync
will print ``Income:Interest`` as the other account.
resync
------
By default, ledger-autosync will process transactions backwards, and
stop when it sees a transaction that is already in ledger. To force it
to process all transactions up to the ``--max`` days back in time
(default: 90), use the ``--resync`` option. This can be useful when
increasing the ``--max`` option. For instance, if you previously
synchronized 90 days and now want to get 180 days of transactions,
ledger-autosync would stop before going back to 180 days without the
``--resync`` option.
python bindings
---------------
If the ledger python bindings are available, ledger-autosync can use them if you
pass in the ``--python`` argument.Note, however, they can be buggy, which is why
they are disabled by default
Plugin support (Experimental)
-----------------------------
ledger-autosync has experimental support for plugins. By placing python files a
directory named ``~/.config/ledger-autosync/plugins/`` it should be possible to
automatically load python files from there. This allows you to extend the csv
converters with your own code. For example, given the input CSV file:
::
"Date","Name","Amount","Balance"
"11/30/2016","Dividend","$1.06","$1,000“
The following converter in the file ``~/.config/ledger-autosync/plugins/my.py``:
::
from ledgerautosync.converter import CsvConverter, Posting, Transaction, Amount
import datetime
import re
class SomeConverter(CsvConverter):
FIELDSET = set(["Date", "Name", Amount", "Balance"])
def __init__(self, *args, **kwargs):
super(SomeConverter, self).__init__(*args, **kwargs)
def convert(self, row):
md = re.match(r"^(\(?)\$([0-9,\.]+)", row['Amount'])
amount = md.group(2).replace(",", "")
if md.group(1) == "(":
reverse = True
else:
reverse = False
if reverse:
account = 'expenses'
else:
account = 'income'
return Transaction(
date=datetime.datetime.strptime(row['Date'], "%m/%d/%Y"),
payee=row['Name'],
postings=[Posting(self.name, Amount(amount, '$', reverse=reverse)),
Posting(account, Amount(amount, '$', reverse=not(reverse)))])
Running ``ledger-autosync file.csv -a assets:bank`` will generate:
::
2016/11/30 Dividend
assets:bank $1.06
income -$1.06
For more examples, see
https://gitlab.com/egh/ledger-autosync/blob/master/ledgerautosync/converter.py#L421
Testing
-------
ledger-autosync uses nose for tests. To test, run nosetests in the
project directory. This will test the ledger, hledger and ledger-python
interfaces. To test a single interface, use nosetests -a hledger. To
test the generic code, use nosetests -a generic. To test both, use
nosetests -a generic -a hledger. For some reason nosetests -a '!hledger'
will not work.
Keywords: ledger accounting
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Office/Business :: Financial :: Accounting
Classifier: Topic :: Office/Business :: Financial :: Investment
Classifier: Topic :: Office/Business :: Financial
ledger-autosync-0.3.5/setup.cfg 0000644 0001750 0001750 00000000073 13111713303 015766 0 ustar egh egh 0000000 0000000 [egg_info]
tag_build =
tag_date = 0
tag_svn_revision = 0
ledger-autosync-0.3.5/ledgerautosync/ 0000755 0001750 0001750 00000000000 13111713303 017175 5 ustar egh egh 0000000 0000000 ledger-autosync-0.3.5/ledgerautosync/__init__.py 0000664 0001750 0001750 00000002023 13110112130 021273 0 ustar egh egh 0000000 0000000 # Copyright (c) 2013, 2014 Erik Hetzner
#
# This file is part of ledger-autosync
#
# ledger-autosync is free software: you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# ledger-autosync is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with ledger-autosync. If not, see
# .
class EmptyInstitutionException(Exception):
def __init__(self, value):
self.value = value
def __str__(self):
return repr(self.value)
class LedgerAutosyncException(Exception):
def __init__(self, value):
self.value = value
def __str__(self):
return repr(self.value)
ledger-autosync-0.3.5/ledgerautosync/sync.py 0000664 0001750 0001750 00000014313 13110110737 020530 0 ustar egh egh 0000000 0000000 # Copyright (c) 2013, 2014 Erik Hetzner
#
# This file is part of ledger-autosync
#
# ledger-autosync is free software: you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# ledger-autosync is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with ledger-autosync. If not, see
# .
from __future__ import absolute_import
from ofxparse import OfxParser
from ledgerautosync.converter import CsvConverter
from ofxparse.ofxparse import InvestmentTransaction
import logging
import csv
class Synchronizer(object):
def __init__(self, lgr):
self.lgr = lgr
class OfxSynchronizer(Synchronizer):
def __init__(self, lgr):
super(OfxSynchronizer, self).__init__(lgr)
def parse_file(self, path, accountname=None):
ofx = OfxParser.parse(file(path))
return (ofx, self.filter(ofx))
def is_txn_synced(self, acctid, txn):
if self.lgr is None:
# User called with --no-ledger
# All transactions are considered "synced" in this case.
return False
else:
ofxid = "%s.%s" % (acctid, txn.id)
return self.lgr.check_transaction_by_id("ofxid", ofxid)
# Filter out comment transactions. These have an amount of 0 and the same
# datetime as the previous transactions.
def filter_comment_txns(self, txns):
last_txn = None
retval = []
for txn in txns:
if (last_txn is not None) and \
hasattr(txn, 'amount') and \
(txn.amount == 0) and \
hasattr(last_txn, 'date') and \
hasattr(txn, 'date') and \
(last_txn.date == txn.date):
# This is a comment transaction
pass
else:
last_txn = txn
retval.append(txn)
return retval
def filter(self, ofx):
def extract_sort_key(txn):
if hasattr(txn, 'tradeDate'):
return txn.tradeDate
elif hasattr(txn, 'date'):
return txn.date
elif hasattr(txn, 'settleDate'):
return txn.settleDate
return None
txns = ofx.account.statement.transactions
if len(txns) == 0:
sorted_txns = txns
else:
sorted_txns = sorted(txns, key=extract_sort_key)
acctid = ofx.account.account_id
retval = [txn for txn in sorted_txns
if not(self.is_txn_synced(acctid, txn))]
return self.filter_comment_txns(retval)
def get_new_txns(self, acct, max_days=999999, resync=False):
if resync or (max_days < 7):
days = max_days
else:
days = 7
last_txns_len = 0
while (True):
logging.debug(
"Downloading %d days of transactions for %s (max_days=%d)." % (
days, acct.description, max_days))
raw = acct.download(days=days)
if raw.read() == 'Server error occured. Received HttpStatusCode of 400':
raise Exception("Error connecting to account %s"%(acct.description))
raw.seek(0)
ofx = OfxParser.parse(raw)
if not(hasattr(ofx, 'account')):
# some banks return this for no txns
if (days >= max_days):
logging.debug("Hit max days.")
# return None to let the caller know that we don't
# even have account info
return (None, None)
else:
days = days * 2
if (days > max_days):
days = max_days
logging.debug(
"empty account: increasing days ago to %d." % (days))
last_txns_len = 0
else:
txns = ofx.account.statement.transactions
new_txns = self.filter(ofx)
logging.debug("txns: %d" % (len(txns)))
logging.debug("new txns: %d" % (len(new_txns)))
if ((len(txns) > 0) and (last_txns_len == len(txns))):
# not getting more txns than last time; we have
# reached the beginning
logging.debug("Not getting more txns than last time, done.")
return (ofx, new_txns)
elif (len(txns) > len(new_txns)) or (days >= max_days):
# got more txns than were new or hit max_days, we've
# reached a stopping point
if (days >= max_days):
logging.debug("Hit max days.")
else:
logging.debug("Got some stale txns.")
return (ofx, new_txns)
else:
# all txns were new, increase how far back we go
days = days * 2
if (days > max_days):
days = max_days
logging.debug("Increasing days ago to %d." % (days))
last_txns_len = len(txns)
class CsvSynchronizer(Synchronizer):
def __init__(self, lgr):
super(CsvSynchronizer, self).__init__(lgr)
def parse_file(self, path, accountname=None, unknownaccount=None):
with open(path, 'rb') as f:
dialect = csv.Sniffer().sniff(f.read(1024))
f.seek(0)
dialect.skipinitialspace = True
reader = csv.DictReader(f, dialect=dialect)
converter = CsvConverter.make_converter(
reader,
name=accountname,
ledger=self.lgr,
unknownaccount=unknownaccount)
return [converter.convert(row)
for row in reader
if not(self.lgr.check_transaction_by_id(
"csvid", converter.get_csv_id(row)))]
ledger-autosync-0.3.5/ledgerautosync/ledgerwrap.py 0000644 0001750 0001750 00000020670 13110110401 021675 0 ustar egh egh 0000000 0000000 # Copyright (c) 2013, 2014 Erik Hetzner
#
# This file is part of ledger-autosync
#
# ledger-autosync is free software: you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# ledger-autosync is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with ledger-autosync. If not, see
# .
from __future__ import absolute_import
import csv
import os
import re
import distutils.spawn
import subprocess
from subprocess import Popen, PIPE
from threading import Thread
from Queue import Queue, Empty
from ledgerautosync.converter import Converter
import logging
from fuzzywuzzy import process
csv.register_dialect('ledger', delimiter=',', quoting=csv.QUOTE_ALL, escapechar="\\")
def mk_ledger(ledger_file):
if Ledger.available():
return Ledger(ledger_file)
elif HLedger.available():
return HLedger(ledger_file)
elif LedgerPython.available():
# string_read=True works around http://bugs.ledger-cli.org/show_bug.cgi?id=973
return LedgerPython(ledger_file, string_read=True)
else:
raise Exception("Neither ledger 3 nor hledger found!")
class MetaLedger(object):
@staticmethod
def windows_clean(a):
def clean_str(s):
s = s.replace('%', '')
s = s.replace(' ', '\ ')
s = s.replace('/', '\/')
return s
return [clean_str(s) for s in a]
@staticmethod
def clean_payee(s):
s = s.replace('%', '')
s = s.replace('/', '\/')
s = s.replace("'", "")
return s
# Return True if this ledgerlike interface is available
@staticmethod
def available():
return False
def add_payee(self, payee, account):
if payee not in self.payees:
self.payees[payee] = []
self.payees[payee].append(account)
def filter_accounts(self, accts, exclude):
accts_filtered = [a for a in accts if a != exclude]
if accts_filtered:
return accts_filtered[-1]
else:
return None
def get_account_by_payee(self, payee, exclude):
self.load_payees()
return self.filter_accounts(self.payees.get(payee, []), exclude)
def get_fuzzy_account_by_payee(self, payee, exclude):
self.load_payees()
fuzzed_payee = process.extractOne(payee, self.payees)[0]
return self.filter_accounts([fuzzed_payee], exclude)
def __init__(self):
self.payees = None
class Ledger(MetaLedger):
@staticmethod
def available():
return ((distutils.spawn.find_executable('ledger') is not None) and
(Popen(["ledger", "--version"], stdout=PIPE).
communicate()[0]).startswith("Ledger 3"))
def __init__(self, ledger_file=None, no_pipe=True):
if distutils.spawn.find_executable('ledger') is None:
raise Exception("ledger was not found in $PATH")
self._item = ""
def enqueue_output(out, queue):
buff = ""
while (buff is not None):
buff = out.read(1)
if (buff is not None):
self._item += buff
if self._item.endswith("] "): # prompt
queue.put(self._item[0:-2])
self._item = ""
out.close()
self.use_pipe = (os.name == 'posix') and not(no_pipe)
self.args = ["ledger", "--args-only"]
if ledger_file is not None:
self.args += ["-f", ledger_file]
if self.use_pipe:
self.p = Popen(self.args, bufsize=1, stdin=PIPE, stdout=PIPE,
close_fds=True)
self.q = Queue()
self.t = Thread(target=enqueue_output, args=(self.p.stdout, self.q))
self.t.daemon = True # thread dies with the program
self.t.start()
# read output until prompt
try:
self.q.get(True, 5)
except Empty:
logging.error("Could not get prompt (]) from ledger!")
logging.error("Received: %s" % (self._item))
exit(1)
super(Ledger, self).__init__()
@staticmethod
def pipe_quote(a):
def quote(s):
s = s.replace('/', '\\\\/')
s = s.replace('%', '')
if not(re.match(r"^\w+$", s)):
s = "\"%s\"" % (s)
return s
return [quote(s) for s in a]
def run(self, cmd):
if self.use_pipe:
self.p.stdin.write("csv ")
self.p.stdin.write(" ".join(Ledger.pipe_quote(cmd)))
self.p.stdin.write("\n")
logging.debug(" ".join(Ledger.pipe_quote(cmd)))
try:
return csv.reader(self.q.get(True, 5), dialect='ledger')
except Empty:
logging.error("Could not get prompt from ledger!")
exit(1)
else:
cmd = self.args + ["csv"] + cmd
if os.name == 'nt':
cmd = MetaLedger.windows_clean(cmd)
return csv.reader(subprocess.check_output(cmd).splitlines(), dialect='ledger')
def check_transaction_by_id(self, key, value):
q = ["-E", "meta", "%s=%s" % (key, Converter.clean_id(value))]
try:
self.run(q).next()
return True
except StopIteration:
return False
def load_payees(self):
if self.payees is None:
self.payees = {}
r = self.run(["show"])
for line in r:
self.add_payee(line[2], line[3])
class LedgerPython(MetaLedger):
@staticmethod
def available():
try:
import ledger
return True
except ImportError:
return False
def __init__(self, ledger_file=None, string_read=True):
# sanity check for ledger python interface
try:
import ledger
except ImportError:
raise Exception("Ledger python interface not found!")
if ledger_file is None:
# TODO - better loading
raise Exception
else:
if string_read:
self.session = ledger.Session()
self.journal = self.session.read_journal_from_string(
open(ledger_file).read())
else:
self.journal = ledger.read_journal(ledger_file)
super(LedgerPython, self).__init__()
def load_payees(self):
if self.payees is None:
self.payees = {}
for xact in self.journal:
for post in xact.posts():
self.add_payee(xact.payee, post.reported_account().fullname())
def check_transaction_by_id(self, key, value):
q = self.journal.query("-E meta %s=\"%s\"" %
(key, Converter.clean_id(value)))
return len(q) > 0
class HLedger(MetaLedger):
@staticmethod
def available():
return (distutils.spawn.find_executable('hledger') is not None)
@staticmethod
def quote(a):
def quote_str(s):
s = s.replace('(', '\(')
s = s.replace(')', '\)')
return s
return [quote_str(s) for s in a]
def __init__(self, ledger_file=None):
if distutils.spawn.find_executable('hledger') is None:
raise Exception("hledger was not found in $PATH")
self.args = ["hledger"]
if ledger_file is not None:
self.args += ["-f", ledger_file]
super(HLedger, self).__init__()
def run(self, cmd):
cmd = HLedger.quote(self.args + cmd)
if os.name == 'nt':
cmd = MetaLedger.windows_clean(cmd)
logging.debug(" ".join(cmd))
return subprocess.check_output(cmd)
def check_transaction_by_id(self, key, value):
cmd = ["reg", "tag:%s=%s" % (key, Converter.clean_id(value))]
return self.run(cmd) != ''
def load_payees(self):
if self.payees is None:
self.payees = {}
cmd = ["reg", "-O", "csv"]
r = csv.DictReader(self.run(cmd).splitlines())
headers = r.next()
for line in r:
self.add_payee(line['description'], line['account'])
ledger-autosync-0.3.5/ledgerautosync/converter.py 0000644 0001750 0001750 00000047155 13103772260 021602 0 ustar egh egh 0000000 0000000 # Copyright (c) 2013, 2014 Erik Hetzner
# Portions Copyright (c) 2016 James S Blachly, MD
#
# This file is part of ledger-autosync
#
# ledger-autosync is free software: you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# ledger-autosync is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with ledger-autosync. If not, see
# .
from __future__ import absolute_import
from decimal import Decimal
import re
from ofxparse.ofxparse import Transaction as OfxTransaction, InvestmentTransaction
from ledgerautosync import EmptyInstitutionException
import datetime
import hashlib
AUTOSYNC_INITIAL = "autosync_initial"
ALL_AUTOSYNC_INITIAL = "all.%s" % (AUTOSYNC_INITIAL)
class SecurityList(object):
"""
The SecurityList represents the OFX ...
and holds securities present in the OFX records
... as implemented by OFXparse only includes:
{memo, name, ticker, uniqueid}
Unfortunately does not provide uniqueid_type or currency
It is iterable, and also provides lookup table (LUT) functionality
provides __next__() for Py3
"""
def __init__(self, securities):
self.cusip_lut = dict()
self.ticker_lut = dict()
self._iter = iter(securities)
self.securities = securities
if len(securities) == 0: return
# index
for sec in securities:
# unfortunately OFXparse does not currently implement
# security.uniqueid_type so I am presuming here
if sec.uniqueid: self.cusip_lut[sec.uniqueid] = sec
if sec.ticker: self.ticker_lut[sec.ticker] = sec
# This indexing strategy (whereby I index the object instead of
# the inverse value (e.g. ticker symbol) directly has a flaw
# in that an OFX file could define a security list section and
# list CUSIPs without ticker property, or the converse
def __iter__(self):
return self
def __next__(self): # Py3 iterable
return next(self._iter)
def next(self): # Python 2
return next(self._iter)
def __len__(self):
return len(self.securities)
# one possibility is to just implement __getitem__(),
# however since OFXparse does not implement securitylist.security.uniqueid_type
# I'll have no idea if what I am seeing is a CUSISP
# unless I look it up specifically as a CUSIP (and it exists)
def find_cusip(self, cusip):
if cusip in self.cusip_lut: return self.cusip_lut[cusip]
else: return None
def find_ticker(self, ticker):
if ticker in self.ticker_lut: return self.ticker_lut[ticker]
else: return None
class Transaction(object):
def __init__(self, date, payee, postings, cleared=False, metadata={}, aux_date=None):
self.date = date
self.aux_date = aux_date
self.payee = payee
self.postings = postings
self.metadata = metadata
self.cleared = cleared
def format(self, indent=4):
retval = ""
cleared_str = " "
if self.cleared:
cleared_str = " * "
aux_date_str = ""
if self.aux_date is not None:
aux_date_str = "=%s"%(self.aux_date.strftime("%Y/%m/%d"))
retval += "%s%s%s%s\n"%(self.date.strftime("%Y/%m/%d"), aux_date_str, cleared_str, self.payee)
for k,v in self.metadata.iteritems():
retval += "%s; %s: %s\n" % (" "*indent, k, v)
for posting in self.postings:
retval += posting.format(indent)
return retval
class Posting(object):
def __init__(self, account, amount, asserted=None, unit_price=None):
self.account = account
self.amount = amount
self.asserted = asserted
self.unit_price = unit_price
def format(self, indent=4):
space_count = 65 - indent - len(self.account) - len(self.amount.format())
if space_count < 2:
space_count = 2
retval = "%s%s%s%s" % (
" " * indent, self.account, " "*space_count, self.amount.format())
if self.asserted is not None:
retval = "%s = %s"%(retval, self.asserted.format())
if self.unit_price is not None:
retval = "%s @ %s"%(retval, self.unit_price.format())
return "%s\n"%(retval)
class Amount(object):
def __init__(self, number, currency, reverse=False, unlimited=False):
self.number = Decimal(number)
self.reverse = reverse
self.unlimited = unlimited
self.currency = currency
def format(self):
# Commodities must be quoted in ledger if they have
# whitespace or numerals.
if re.search(r'[\s0-9]', self.currency):
currency = "\"%s\"" % (self.currency)
else:
currency = self.currency
if self.unlimited:
number = str(abs(self.number))
else:
number = "%0.2f" % (abs(self.number))
if self.number.is_signed() != self.reverse:
prefix = "-"
else:
prefix = ""
if len(currency) == 1:
# $ comes before
return "%s%s%s" % (prefix, currency, number)
else:
# USD comes after
return "%s%s %s" % (prefix, number, currency)
class Converter(object):
@staticmethod
def clean_id(id):
return id.replace('/', '_').\
replace('$', '_').\
replace(' ', '_').\
replace('@', '_').\
replace('*', '_').\
replace('[', '_').\
replace(']', '_')
def __init__(self, ledger=None, unknownaccount=None, currency='$', indent=4):
self.lgr = ledger
self.indent = indent
self.unknownaccount = unknownaccount
self.currency = currency.upper()
if self.currency == "USD":
self.currency = "$"
def mk_dynamic_account(self, payee, exclude):
if self.lgr is None:
return self.unknownaccount or 'Expenses:Misc'
else:
account = self.lgr.get_account_by_payee(payee, exclude)
if account is None:
return self.unknownaccount or 'Expenses:Misc'
else:
return account
class OfxConverter(Converter):
def __init__(self, ofx, name, indent=4, ledger=None, fid=None,
unknownaccount=None):
super(OfxConverter, self).__init__(ledger=ledger,
indent=indent,
unknownaccount=unknownaccount,
currency=ofx.account.statement.currency)
self.acctid = ofx.account.account_id
# build SecurityList (including indexing by CUSIP and ticker symbol)
if hasattr(ofx, 'security_list') and ofx.security_list is not None:
self.security_list = SecurityList(ofx.security_list)
else:
self.security_list = SecurityList([])
if fid is not None:
self.fid = fid
else:
if ofx.account.institution is None:
raise EmptyInstitutionException(
"Institution provided by OFX is empty and no fid supplied!")
else:
self.fid = ofx.account.institution.fid
self.name = name
def mk_ofxid(self, txnid):
return Converter.clean_id("%s.%s.%s" % (self.fid, self.acctid, txnid))
def format_payee(self, txn):
payee = None
memo = None
if (hasattr(txn, 'payee')):
payee = txn.payee
if (hasattr(txn, 'memo')):
memo = txn.memo
if (payee is None or payee == '') and (memo is None or memo == ''):
retval = "%s: %s"%(self.name, txn.type)
if txn.type == 'transfer' and hasattr(txn, 'tferaction'):
retval += ": %s"%(txn.tferaction.lower())
return retval
if (payee is None or payee == '') or txn.memo.startswith(payee):
return memo
elif (memo is None or memo == '') or payee.startswith(memo):
return payee
else:
return "%s %s" % (payee, memo)
def format_balance(self, statement):
# Get date. Ensure the date is a date-like object.
if (hasattr(statement, 'balance_date') and
hasattr(statement.balance_date, 'strftime')):
date = statement.balance_date
elif (hasattr(statement, 'end_date') and
hasattr(statement.end_date, 'strftime')):
date = statement.end_date
else:
return ""
if (hasattr(statement, 'balance')):
return Transaction(
date=date,
cleared=True,
payee="--Autosync Balance Assertion",
postings=[
Posting(
self.name,
Amount(Decimal("0"), currency=self.currency),
asserted=Amount(statement.balance, self.currency))
]).format(self.indent)
else:
return ""
def format_initial_balance(self, statement):
if (hasattr(statement, 'balance')):
initbal = statement.balance
for txn in statement.transactions:
initbal -= txn.amount
return Transaction(
date=statement.start_date,
payee="--Autosync Initial Balance",
cleared=True,
postings=[
Posting(
self.name,
Amount(initbal, currency=self.currency)).format(self.indent),
Posting(
"Assets:Equity",
Amount(initbal, currency=self.currency, reverse=True)).format(self.indent)
],
metadata={ "ofxid": self.mk_ofxid(AUTOSYNC_INITIAL) }
).format(self.indent)
else:
return ""
# Return the ticker symbol of the security with CUSIP, if it exists in the
# security_list mapping. Otherwise, simply return the CUSIP.
def maybe_get_ticker(self, cusip):
security = self.security_list.find_cusip(cusip)
if security is not None:
return security.ticker
else:
return cusip
def convert(self, txn):
"""
Convert an OFX Transaction to a posting
"""
ofxid = self.mk_ofxid(txn.id)
if isinstance(txn, OfxTransaction):
return Transaction(
date=txn.date,
payee=self.format_payee(txn),
metadata={"ofxid": ofxid},
postings=[
Posting(
self.name,
Amount(txn.amount, self.currency)
),
Posting(
self.mk_dynamic_account(self.format_payee(txn), exclude=self.name),
Amount(txn.amount, self.currency, reverse=True)
)]
)
elif isinstance(txn, InvestmentTransaction):
acct1 = self.name
acct2 = self.name
posting1 = None
posting2 = None
metadata = {"ofxid": ofxid}
security = self.maybe_get_ticker(txn.security)
if isinstance(txn.type, basestring):
# recent versions of ofxparse
if re.match('^(buy|sell)', txn.type):
acct2 = self.unknownaccount or 'Assets:Unknown'
elif txn.type == 'transfer':
acct2 = 'Transfer'
elif txn.type == 'reinvest':
# reinvestment of income
# TODO: make this configurable
acct2 = 'Income:Interest'
elif txn.type == 'income' and txn.income_type == 'DIV':
# Fidelity lists non-reinvested dividend income as
# type: income, income_type: DIV
# TODO: determine how dividend income is listed from other institutions
# income/DIV transactions do not involve buying or selling a security
# so their postings need special handling compared to others
metadata['dividend_from'] = security
acct2 = 'Income:Dividends'
posting1 = Posting( acct1,
Amount(txn.total, self.currency))
posting2 = Posting( acct2,
Amount(txn.total, self.currency, reverse=True ))
else:
# ???
pass
else:
# Old version of ofxparse
if (txn.type in [0, 1, 3, 4]):
# buymf, sellmf, buystock, sellstock
acct2 = self.unknownaccount or 'Assets:Unknown'
elif (txn.type == 2):
# reinvest
acct2 = 'Income:Interest'
else:
# ???
pass
aux_date = None
if txn.settleDate is not None and \
txn.settleDate != txn.tradeDate:
aux_date = txn.settleDate
# income/DIV already defined above;
# this block defines all other posting types
if posting1 is None and posting2 is None:
posting1 = Posting(acct1,
Amount(txn.units, security, unlimited=True),
unit_price=Amount(txn.unit_price, self.currency, unlimited=True))
posting2 = Posting(acct2,
Amount(txn.units * txn.unit_price, self.currency, reverse=True))
else:
# Previously defined if type:income income_type/DIV
pass
return Transaction(
date=txn.tradeDate,
aux_date=txn.settleDate,
payee=self.format_payee(txn),
metadata=metadata,
postings=[ posting1, posting2 ]
)
def format_position(self, pos):
if hasattr(pos, 'date') and hasattr(pos, 'security') and \
hasattr(pos, 'unit_price'):
dateStr = pos.date.strftime("%Y/%m/%d %H:%M:%S")
return "P %s %s %s\n" % (dateStr, self.maybe_get_ticker(pos.security), pos.unit_price)
class CsvConverter(Converter):
@staticmethod
def make_converter(csv, name=None, **kwargs):
fieldset = set(csv.fieldnames)
for klass in CsvConverter.__subclasses__():
if klass.FIELDSET <= fieldset:
return klass(csv, name=name, **kwargs)
# Found no class, bail
raise Exception('Cannot determine CSV type')
# By default, return an MD5 of the key-value pairs in the row.
# If a better ID is available, should be overridden.
def get_csv_id(self, row):
h = hashlib.md5()
for key in sorted(row.keys()):
h.update("%s=%s\n"%(key, row[key]))
return h.hexdigest()
def __init__(self, csv, name=None, indent=4, ledger=None, unknownaccount=None):
super(CsvConverter, self).__init__(
ledger=ledger,
indent=indent,
unknownaccount=unknownaccount)
self.name = name
self.csv = csv
class PaypalConverter(CsvConverter):
FIELDSET = set(['Currency', 'Date', 'Gross', 'Item Title', 'Name', 'Net', 'Status', 'To Email Address', 'Transaction ID', 'Type'])
def __init__(self, *args, **kwargs):
super(PaypalConverter, self).__init__(*args, **kwargs)
def get_csv_id(self, row):
return "paypal.%s"%(Converter.clean_id(row['Transaction ID']))
def convert(self, row):
if (((row['Status'] != "Completed") and (row['Status'] != "Refunded") and (row['Status'] != "Reversed")) or (row['Type'] == "Shopping Cart Item")):
return ""
else:
currency = row['Currency']
if row['Type'] == "Add Funds from a Bank Account" or row['Type'] == "Charge From Debit Card":
postings=[
Posting(
self.name,
Amount(Decimal(row['Net']), currency)
),
Posting(
"Transfer:Paypal",
Amount(Decimal(row['Net']), currency, reverse=True)
)]
else:
postings=[
Posting(
self.name,
Amount(Decimal(row['Gross']), currency)
),
Posting(
# TODO Our payees are breaking the payee search in mk_dynamic_account
"Expenses:Misc", #self.mk_dynamic_account(payee, exclude=self.name),
Amount(Decimal(row['Gross']), currency, reverse=True)
)]
return Transaction(
date=datetime.datetime.strptime(row['Date'], "%m/%d/%Y"),
payee=re.sub(
r"\s+", " ",
"%s %s %s ID: %s, %s"%(row['Name'], row['To Email Address'], row['Item Title'], row['Transaction ID'], row['Type'])),
metadata={"csvid": self.get_csv_id(row)},
postings=postings)
class AmazonConverter(CsvConverter):
FIELDSET = set(['Currency', 'Title', 'Order Date', 'Order ID'])
def __init__(self, *args, **kwargs):
super(AmazonConverter, self).__init__(*args, **kwargs)
def mk_amount(self, row, reverse=False):
currency = row['Currency']
if currency == "USD": currency = "$"
return Amount(Decimal(re.sub(r"\$", "", row['Item Total'])), currency, reverse=reverse)
def get_csv_id(self, row):
return "amazon.%s"%(Converter.clean_id(row['Order ID']))
def convert(self, row):
return Transaction(
date=datetime.datetime.strptime(row['Order Date'], "%m/%d/%y"),
payee=row['Title'],
metadata={
"url": "https://www.amazon.com/gp/css/summary/print.html/ref=od_aui_print_invoice?ie=UTF8&orderID=%s"%(row['Order ID']),
"csvid": self.get_csv_id(row)},
postings=[
Posting(self.name, self.mk_amount(row)),
Posting("Expenses:Misc", self.mk_amount(row, reverse=True))
])
class MintConverter(CsvConverter):
FIELDSET = set(['Date', 'Amount', 'Description', 'Account Name', 'Category', 'Transaction Type'])
def __init__(self, *args, **kwargs):
super(MintConverter, self).__init__(*args, **kwargs)
def mk_amount(self, row, reverse=False):
return Amount(Decimal(row['Amount']), '$', reverse=reverse)
def convert(self, row):
account = self.name
if account is None:
account = row['Account Name']
postings = []
if (row['Transaction Type'] == 'credit'):
postings = [Posting(account, self.mk_amount(row, reverse=True)),
Posting(row['Category'], self.mk_amount(row))]
else:
postings = [Posting(account, self.mk_amount(row)),
Posting("Expenses:%s"%(row['Category']), self.mk_amount(row, reverse=True))]
return Transaction(
date=datetime.datetime.strptime(row['Date'], "%m/%d/%Y"),
metadata={"csvid": "mint.%s"%(self.get_csv_id(row))},
payee=row['Description'],
postings=postings)
ledger-autosync-0.3.5/ledgerautosync/plugins.py 0000644 0001750 0001750 00000000000 13032356422 021225 0 ustar egh egh 0000000 0000000 ledger-autosync-0.3.5/ledgerautosync/cli.py 0000755 0001750 0001750 00000024610 13111456523 020334 0 ustar egh egh 0000000 0000000 #!/usr/bin/env python
# Copyright (c) 2013, 2014 Erik Hetzner
# Portions Copyright (c) 2016 James S Blachly, MD
#
# This file is part of ledger-autosync
#
# ledger-autosync is free software: you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# ledger-autosync is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with ledger-autosync. If not, see
# .
from __future__ import absolute_import
from ofxclient.config import OfxConfig
import argparse
import csv
from ledgerautosync import EmptyInstitutionException, LedgerAutosyncException
from ledgerautosync.converter import OfxConverter, CsvConverter, AUTOSYNC_INITIAL, \
ALL_AUTOSYNC_INITIAL
from ledgerautosync.converter import SecurityList
from ledgerautosync.sync import OfxSynchronizer, CsvSynchronizer
from ledgerautosync.ledgerwrap import mk_ledger, Ledger, HLedger, LedgerPython
import logging
import re
import sys
import traceback
import os
import os.path
import imp
def find_ledger_file(ledgerrcpath=None):
"""Returns main ledger file path or raise exception if it cannot be \
found."""
if ledgerrcpath is None:
ledgerrcpath = os.path.abspath(os.path.expanduser("~/.ledgerrc"))
if "LEDGER_FILE" in os.environ:
return os.path.abspath(os.path.expanduser(os.environ["LEDGER_FILE"]))
elif os.path.exists(ledgerrcpath):
# hacky
ledgerrc = open(ledgerrcpath)
for line in ledgerrc.readlines():
md = re.match(r"--file\s+([^\s]+).*", line)
if md is not None:
return os.path.abspath(os.path.expanduser(md.group(1)))
else:
return None
def print_results(converter, ofx, ledger, txns, args):
"""
This function is the final common pathway of program:
Print initial balance if requested;
Print transactions surviving de-duplication filter;
Print balance assertions if requested;
Print commodity prices obtained from position statements
"""
if args.initial:
if (not(ledger.check_transaction_by_id
("ofxid", converter.mk_ofxid(AUTOSYNC_INITIAL))) and
not(ledger.check_transaction_by_id("ofxid", ALL_AUTOSYNC_INITIAL))):
print converter.format_initial_balance(ofx.account.statement)
for txn in txns:
print converter.convert(txn).format(args.indent)
if args.assertions:
print converter.format_balance(ofx.account.statement)
# if OFX has positions use these to obtain commodity prices
# and print "P" records to provide dated/timed valuations
# Note that this outputs only the commodity price,
# not your position (e.g. # shares), even though this is in the OFX record
if hasattr(ofx.account.statement, 'positions'):
for pos in ofx.account.statement.positions:
print converter.format_position(pos)
def sync(ledger, accounts, args):
sync = OfxSynchronizer(ledger)
for acct in accounts:
try:
(ofx, txns) = sync.get_new_txns(acct, resync=args.resync,
max_days=args.max)
if ofx is not None:
converter = OfxConverter(ofx=ofx,
name=acct.description,
ledger=ledger,
indent=args.indent,
unknownaccount=args.unknownaccount)
print_results(converter, ofx, ledger, txns, args)
except KeyboardInterrupt:
raise
except:
sys.stderr.write("Caught exception processing %s" %
(acct.description))
traceback.print_exc(file=sys.stderr)
def import_ofx(ledger, args):
sync = OfxSynchronizer(ledger)
(ofx, txns) = sync.parse_file(args.PATH)
accountname = args.account
if accountname is None:
if ofx.account.institution is not None:
accountname = "%s:%s" % (ofx.account.institution.organization,
ofx.account.account_id)
else:
raise EmptyInstitutionException("Institution provided by OFX is \
empty and no accountname supplied!")
converter = OfxConverter(ofx=ofx,
name=accountname,
ledger=ledger,
indent=args.indent,
fid=args.fid,
unknownaccount=args.unknownaccount)
print_results(converter, ofx, ledger, txns, args)
def import_csv(ledger, args):
if args.account is None:
raise Exception("When importing a CSV file, you must specify an account name.")
sync = CsvSynchronizer(ledger)
accountname = args.account
for txn in sync.parse_file(args.PATH, accountname=args.account):
print txn.format(args.indent)
def load_plugins(config_dir):
plugin_dir = os.path.join(config_dir, 'ledger-autosync', 'plugins')
if os.path.isdir(plugin_dir):
for plugin in filter(re.compile('.py$', re.IGNORECASE).search, os.listdir(plugin_dir)):
# Quiet loader
import ledgerautosync.plugins
path = os.path.join(plugin_dir, plugin)
imp.load_source('ledgerautosync.plugins.%s'%(os.path.splitext(plugin)[0]), path)
def run(args=None, config=None):
if args is None:
args = sys.argv[1:]
parser = argparse.ArgumentParser(description='Synchronize ledger.')
parser.add_argument('-m', '--max', type=int, default=90,
help='maximum number of days to process')
parser.add_argument('-r', '--resync', action='store_true', default=False,
help='do not stop until max days reached')
parser.add_argument('PATH', nargs='?', help='do not sync; import from OFX \
file')
parser.add_argument('-a', '--account', type=str, default=None,
help='sync only the named account; \
if importing from file, set account name for import')
parser.add_argument('-l', '--ledger', type=str, default=None,
help='specify ledger file to READ for syncing')
parser.add_argument('-L', dest='no_ledger', action='store_true', default=False,
help='do not de-duplicate against a ledger file')
parser.add_argument('-i', '--indent', type=int, default=4,
help='number of spaces to use for indentation')
parser.add_argument('--initial', action='store_true', default=False,
help='create initial balance entries')
parser.add_argument('--fid', type=int, default=None,
help='pass in fid value for OFX files that do not \
supply it')
parser.add_argument('--unknown-account', type=str, dest='unknownaccount',
default=None,
help='specify account name to use when one can\'t be \
found by payee')
parser.add_argument('--assertions', action='store_true', default=False,
help='create balance assertion entries')
parser.add_argument('-d', '--debug', action='store_true', default=False,
help='enable debug logging')
parser.add_argument('--hledger', action='store_true', default=False,
help='force use of hledger (on by default if invoked \
as hledger-autosync)')
parser.add_argument('--python', action='store_true', default=False,
help='use the ledger python interface')
parser.add_argument('--slow', action='store_true', default=False,
help='use slow, but possibly more robust, method of \
calling ledger (no subprocess)')
parser.add_argument('--which', action='store_true', default=False,
help='display which version of ledger (cli), hledger, \
or ledger (python) will be used by ledger-autosync to check for previous \
transactions')
args = parser.parse_args(args)
if sys.argv[0][-16:] == "hledger-autosync":
args.hledger = True
ledger_file = None
if args.ledger and args.no_ledger:
raise LedgerAutosyncException('You cannot specify a ledger file and -L')
elif args.ledger:
ledger_file = args.ledger
else:
ledger_file = find_ledger_file()
if args.debug:
logging.basicConfig(level=logging.DEBUG)
if ledger_file is None:
sys.stderr.write("LEDGER_FILE environment variable not set, and no \
.ledgerrc file found, and -l argument was not supplied: running with deduplication disabled. \
All transactions will be printed!")
ledger = None
elif args.no_ledger:
ledger = None
elif args.hledger:
ledger = HLedger(ledger_file)
elif args.python:
ledger = LedgerPython(ledger_file=ledger_file)
elif args.slow:
ledger = Ledger(ledger_file=ledger_file, no_pipe=True)
else:
ledger = mk_ledger(ledger_file)
if args.which:
sys.stderr.write("ledger-autosync is using ")
if type(ledger) == Ledger:
sys.stderr.write("ledger (cli)\n")
elif type(ledger) == HLedger:
sys.stderr.write("hledger\n")
elif type(ledger) == LedgerPython:
sys.stderr.write("ledger.so (python)\n")
exit()
config_dir = os.environ.get('XDG_CONFIG_HOME',
os.path.join(os.path.expanduser("~"),
'.config'))
load_plugins(config_dir)
if args.PATH is None:
if config is None:
config_file = os.path.join(config_dir, 'ofxclient.ini')
if (os.path.exists(config_file)):
config = OfxConfig(file_name=config_file)
else:
config = OfxConfig()
accounts = config.accounts()
if args.account:
accounts = [acct for acct in accounts
if acct.description == args.account]
sync(ledger, accounts, args)
else:
_, file_extension = os.path.splitext(args.PATH)
if file_extension == '.csv':
import_csv(ledger, args)
else:
import_ofx(ledger, args)
if __name__ == '__main__':
run()
ledger-autosync-0.3.5/LICENSE 0000644 0001750 0001750 00000104513 12271402266 015167 0 ustar egh egh 0000000 0000000 GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
Copyright (C)
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
.
ledger-autosync-0.3.5/fixtures/ 0000755 0001750 0001750 00000000000 13111713303 016016 5 ustar egh egh 0000000 0000000 ledger-autosync-0.3.5/fixtures/apostrophe.ofx 0000664 0001750 0001750 00000002224 12743331011 020724 0 ustar egh egh 0000000 0000000 OFXHEADER:100
DATA:OFXSGML
VERSION:102
SECURITY:NONE
ENCODING:USASCII
CHARSET:1252
COMPRESSION:NONE
OLDFILEUID:NONE
NEWFILEUID:NONE
0
INFO
20130525225731.258
ENG
20050531060000.000
FAKE
1101
51123
9774652
0
0
INFO
USD
5472369148
1452687~7
CHECKING
20000101070000.000
20140920170000.000
PAYMENT
20140920170000[0:GMT]
-58.73
201409206
201409206
REPLACE
TRADER JOE'S #541 QPS
100.99
20140920170000.000
75.99
20140920170000.000
ledger-autosync-0.3.5/fixtures/mint.csv 0000664 0001750 0001750 00000000534 12750267742 017531 0 ustar egh egh 0000000 0000000 "Date","Description","Original Description","Amount","Transaction Type","Category","Account Name","Labels","Notes"
"8/02/2016","Amazon","AMAZON MKTPLACE PMTS AMZN.COM/BILL WA","29.99","debit","Shopping","1234","",""
"6/02/2016","Autopay Rautopay Auto","AUTOPAY 000000000000000RAUTOPAY AUTO-PMT","123.45","credit","Credit Card Payment","1234","",""
ledger-autosync-0.3.5/fixtures/income.ofx 0000664 0001750 0001750 00000003223 13000460205 020005 0 ustar egh egh 0000000 0000000 OFXHEADER:100
DATA:OFXSGML
VERSION:102
SECURITY:NONE
ENCODING:USASCII
CHARSET:1252
COMPRESSION:NONE
OLDFILEUID:NONE
NEWFILEUID:NONE
0
INFO
SUCCESS
20150909084609.717[-6:MDT]
ENG
EXAMPLE
1234
1234
0
0
INFO
SUCCESS
20140630000000.000[-6:MDT]
USD
example.org
12345678.123456-01
20160908000000.000[-4:EDT]
20161008121253.321[-4:EDT]
redacted
20161012000000.000[-4:EDT]
DIVIDEND RECEIVED
cusip_redacted
CUSIP
DIV
+00000000001234.5600
CASH
CASH
1.00
USD
ledger-autosync-0.3.5/fixtures/checking-dynamic-account.lgr 0000664 0001750 0001750 00000000511 12210405722 023354 0 ustar egh egh 0000000 0000000 2011/01/01 AUTOMATIC WITHDRAWAL, ELECTRIC BILL WEB(S )
Assets:Foo -$10.00
Expenses:Bar
2011/01/02 Generic
Assets:Foo -$20.00
Expenses:Foo
2011/02/02 Generic
Assets:Foo -$15.00
Expenses:Bar
ledger-autosync-0.3.5/fixtures/multiple.lgr 0000664 0001750 0001750 00000000225 12204206224 020361 0 ustar egh egh 0000000 0000000 2011/03/01 Baz
Foo $21.01
Bar
2011/04/01 Baz
Foo $10.01
Bar
ledger-autosync-0.3.5/fixtures/cusip.ofx 0000664 0001750 0001750 00000007025 13005436020 017665 0 ustar egh egh 0000000 0000000 OFXHEADER:100
DATA:OFXSGML
VERSION:102
SECURITY:NONE
ENCODING:USASCII
CHARSET:1252
COMPRESSION:NONE
OLDFILEUID:NONE
NEWFILEUID:d0a0380757f14baba37a454823980c7c
0
INFO
SUCCESS
20161008122549.359[-4:EDT]
ENG
fidelity.com
7776
4335f294b6fb406ba99d3bf473b89e8a
0
INFO
SUCCESS
20161008033008.000[-4:EDT]
USD
fidelity.com
123456789
20160908000000.000[-4:EDT]
20161008122549.439[-4:EDT]
123456789000987654321
20161005000000.000[-4:EDT]
YOU BOUGHT PROSPECTUS
957904675
CUSIP
+0000000001000.00000
000000047.860000000
+00000000000000.0000
+00000000000000.0000
-00000000047860.0000
1.00
USD
CASH
CASH
BUY
123456789000987654322
20160929000000.000[-4:EDT]
DIVIDEND RECEIVED
957904675
CUSIP
DIV
+00000000000005.2300
CASH
CASH
1.00
USD
957904675
CUSIP
CASH
LONG
2000.00000
47.8600000
+00000095720.00
20161008033008.000[-4:EDT]
1.0
USD
957904675
CUSIP
BLACKROCK HEALTH SCIENCES OPP PRT A
SHSAX
47.8600000
20161008033008.000[-4:EDT]
1.000
USD
OTHER
20161008033008.000[-4:EDT]
ledger-autosync-0.3.5/fixtures/checking.ofx 0000664 0001750 0001750 00000003336 12203171114 020315 0 ustar egh egh 0000000 0000000 OFXHEADER:100
DATA:OFXSGML
VERSION:102
SECURITY:NONE
ENCODING:USASCII
CHARSET:1252
COMPRESSION:NONE
OLDFILEUID:NONE
NEWFILEUID:NONE
0
INFO
20130525225731.258
ENG
20050531060000.000
FAKE
1101
51123
9774652
0
0
INFO
USD
5472369148
1452687~7
CHECKING
20000101070000.000
20130525060000.000
CREDIT
20110331120000.000
0.01
0000486
DIVIDEND EARNED FOR PERIOD OF 03
DIVIDEND EARNED FOR PERIOD OF 03/01/2011 THROUGH 03/31/2011 ANNUAL PERCENTAGE YIELD EARNED IS 0.05%
DEBIT
20110405120000.000
-34.51
0000487
AUTOMATIC WITHDRAWAL, ELECTRIC BILL
AUTOMATIC WITHDRAWAL, ELECTRIC BILL WEB(S )
CHECK
20110407120000.000
-25.00
0000488
319
RETURNED CHECK FEE, CHECK # 319
RETURNED CHECK FEE, CHECK # 319 FOR $45.33 ON 04/07/11
100.99
20130525225731.258
75.99
20130525225731.258