Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Cherry-pick changes from README.rst to README.md #11

Merged
merged 2 commits into from

3 participants

@normanr

0ae8e1a merged pull request #8 (two changes to README.rst), but the recent merge of the next branch into the master branch (52027cf) missed those changes. This branch is a cherry-pick of those 2 commits to README.md.

automatthias added some commits
@automatthias automatthias ~/.aib-sucker chmod advice earlier
Move the advice to set the permissions of ~/.aib-sucker to 0600 earlier in the
instructions.
1b2b4c5
@automatthias automatthias Add information about dependencies. 83732ca
@yacoob
Owner

Gah. Thanks.

@yacoob yacoob merged commit f71071b into yacoob:master
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jul 7, 2012
  1. @automatthias @normanr

    ~/.aib-sucker chmod advice earlier

    automatthias authored normanr committed
    Move the advice to set the permissions of ~/.aib-sucker to 0600 earlier in the
    instructions.
  2. @automatthias @normanr

    Add information about dependencies.

    automatthias authored normanr committed
This page is out of date. Refresh to see the latest.
Showing with 23 additions and 9 deletions.
  1. +23 −9 README.md
View
32 README.md
@@ -4,10 +4,21 @@
## Installation
-* Get [setuptools](http://pypi.python.org/pypi/setuptools) if you don't have it already.
-* `umask 022`
-* `python setup.py build`
-* `sudo python setup.py install`
+Install required Python modules:
+
+* BeautifulSoup
+* mechanize
+* setuptools
+
+On Ubuntu and Debian systems, run:
+
+ sudo aptitude install python-beautifulsoup python-mechanize python-setuptools
+
+Execute commands:
+
+ umask 022
+ python setup.py build
+ sudo python setup.py install
If that has completed successfully, you should find `aib2ofx` command
in your Python's `bin` dir.
@@ -15,8 +26,13 @@ in your Python's `bin` dir.
## How to use
-Create a `~/.aib-sucker` file, with AIB login details. It has a JSON
-format, single object with one key per AIB login you want to use.
+Create a `~/.aib-sucker` file, with AIB login details.
+Set the permission bits to 0600 to prevent other system users from reading it.
+
+ touch ~/.aib-sucker
+ chmod 0600 ~/.aib-sucker
+
+It has a JSON format, single object with one key per AIB login you want to use.
{
"bradmajors": {
@@ -59,9 +75,7 @@ will download data for all accounts for all logins.
}
}
-Note that there's no comma after the last account details. Remember to
-run `chmod 600 ~/.aib-sucker`, to make sure that only you can read
-this file.
+Note that there's no comma after the last account details.
Once you've prepared that config file, run:
Something went wrong with that request. Please try again.