Source

jaraco.financial / README

Full commit
jaraco.financial
================

.. contents::

Overview
--------

``jaraco.financial`` implements tools for financial management, particularly
around Open Financial Exchange and Microsoft Money. These scripts help
facilitate the continued use of Money using the free, sunset release, by
enabling mechanical downloads of OFX data from institutions that support OFX.

``jaraco.financial`` is written by Jason R. Coombs.  It is licensed under an
`MIT-style permissive license
<http://www.opensource.org/licenses/mit-license.php>`_.

You can install it with ``easy_install jaraco.financial``, or grab the code
from the `mercurial repository
<https://bitbucket.org/jaraco/jaraco.financial>`_.

Getting Started
---------------

The primary use of this package is the `ofx` command. After installing, run
`ofx --help` for usage. `jaraco.financial` doesn't provide any institutions,
but you can see `jaraco.institutions` for an example of a project that
implements some institutions for use in `jaraco.financial`.

This project is still a work in progress, but if you think you might find
it useful, don't hesitate to contact the author for help.

Planned Changes
---------------

The author plans to add some of the following features:

* Integrate some of the most common institutions.

Accounts File
-------------

The "ofx download-all" command of `jaraco.financial` will retrieve the
OFX transactions in a batch for a group of accounts defined in a JSON file.
Currently, that file must be located in ~/Documents/Financial/accounts.json.
The file should be a JSON list of objects,
each with `institution` and `account` attributes. It should also have a
`type` property of "checking", "savings", "creditline", or other appropriate
OFX type. The institution should reference an institution installed with
jaraco.financial, such as those defined in `jaraco.institutions
<href="http://bitbucket.org/jaraco/jaraco.institutions">`_. The institution
name must match exactly. Here is an
example accounts.json::

	[
		{
			"institution": "Bank of America",
			"account": "12345679",
			"type": "savings"
		},
		{
			"institution": "Wells Fargo",
			"account": "872634126",
			"type": "moneymrkt"
		},
		{
			"institution": "Chase (credit card)",
			"account": "4000111122223333",
			"username": "myusername"
		}
	]

The `username` attribute must be included if the username of the local user
(running the ofx command) differs from the account name on the account.

Changes
-------

1.0
~~~

* `ofx` script now implements different commands. Where one called "ofx"
  before, now call "ofx query".
* Added new command "ofx download-all", which loads the accounts from a JSON
  file (~/Documents/Financial/accounts.json) and downloads transactions for
  the accounts listed in that file.
* Added command "record-document-hashes" for e-mailing record of the
  hashes of each document.

0.2
~~~

* Integrated OFX support based on scripts provided by Jeremy Jongsma. Includes
  ability to specify financial institutions as plugins and download OFX data
  via the command-line script `ofx`.
* Added keyring support, so credentials for financial institutions are stored
  securely within the Windows Vault.
* Added command to clean up temporary files that crash MS Money.

0.1
~~~

* Initial release with script for launching files in MS Money.