PySimple

https://badge.fury.io/py/PySimple.png https://travis-ci.org/TFenby/PySimple.svg?branch=master

A client library for Simple’s online banking site.

Features

  • Basic account balance and goal support

Contents:

Installation

At the command line either via easy_install or pip:

$ easy_install pysimple
$ pip install pysimple

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv pysimple
$ pip install pysimple

Usage

To use PySimple in a project:

import pysimple

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions
Report Bugs

Report bugs at https://github.com/TFenby/pysimple/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.
Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation

PySimple could always use more documentation, whether as part of the official PySimple docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/TFenby/pysimple/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!

Ready to contribute? Here’s how to set up pysimple for local development.

  1. Fork the pysimple repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/pysimple.git
    
  3. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature
    

Now you can make your changes locally.

  1. When you’re done making changes, check that your changes pass style and unit tests, including testing other Python versions with tox:

    $ tox
    

To get tox, just pip install it.

  1. Commit your changes and push your branch to GitHub:

    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature
    
  2. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/TFenby/pysimple under pull requests for active pull requests or run the tox command and make sure that the tests pass for all supported Python versions.
Tips

To run a subset of tests:

$ py.test test/test_pysimple.py

Credits

Development Lead
Contributors

None yet. Why not be the first?

History

0.1.0 2014/12/13

  • First release on PyPI.
  • Initial working release

Modules:

pysimple

pysimple package
Submodules
pysimple.account module
class pysimple.account.Account(username, password)[source]

Bases: object

A Simple account

Main entrypoint for the library

all_goals()[source]

Returns all (active and archived) goals, raw from the API

balances()[source]
static dollars_to_mills(dollars)[source]

Convert dollars to mills, which Simple uses

Parameters:dollars (int, float) – Amount to convert
Returns:Input amount, in mills
Return type:int
goals()[source]

Return a list of active goals in a dict w/ their names as the key

login()[source]

Log in to the bank via the API

Must be done before any other commands will work

Raises exceptions.LoginError:
 On any error in the request
static mills_to_dollars(mills)[source]

Convert mills back to dollars

Parameters:mills (int) – Amount to convert
Returns:Input amount, in mills
Return type:float
transactions()[source]
transfer_between_goals(from_id, to_id, amount)[source]

Transfer between two goals

Parameters:
  • from_id – ID of the source goal
  • to_id – ID of the dest goal
  • amount – Amount, in dollars, to transfer
Raises requests.exceptions.RequestException:
 

On any error

transfer_between_sts(to_id, amount)[source]

Transfer between Safe-to-Spend and a goal

A positive amount will transfer from StS to the goal, and a negative amount will do the opposite.

Parameters:amount (int, float) – Amount, in dollars, to transfer
Raises requests.exceptions.RequestException:
 On any error
pysimple.exceptions module
exception pysimple.exceptions.LoginError[source]

Bases: exceptions.Exception

Login failed

exception pysimple.exceptions.PySimpleException[source]

Bases: exceptions.Exception

Base of all PySimple Exceptions

pysimple.version module
Module contents

Feedback

If you have any suggestions or questions about PySimple feel free to email me at tylerfenby@gmail.com.

If you encounter any errors or problems with PySimple, please let me know! Open an Issue at the GitHub https://github.com/TFenby/pysimple main repository.