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