API

analysis

core

Data Classes

class mymoney.core.data_classes.MyData(expense: DataFrame, trade: DataFrame, balance: DataFrame)[source]: docs here!

class mymoney.core.data_classes.WholeData(path: str, institution_name: str, service_name: str, account_name: str, input_df: DataFrame, sanity_df: DataFrame, output_df: DataFrame, out_type: str)[source]

docs here!

generate_file_name() → str[source]: docs here!

Data Operations

class mymoney.core.data_operations.DataOperations(data_folder_path: str | None = None)[source]

docs here!

append_to_db(data: WholeData)[source]: Get the WholeData and append to the right core data.

initiate_data_folder()[source]

docs here!

Create data folder with core, raw and sanity_check in it. Create 3 csv files with each specific headers.

load_db() → MyData[source]: Read csv files from core folder and return corresponding dataframes.

store_raw_data(data: WholeData, remove_source: bool = False)[source]: docs here!

store_sanity_data(data: WholeData)[source]: docs here!

Executer

class mymoney.core.executer.ExecClass[source]

docs here!

path_to_whole_data(path: str, account_name: str | None = None) → WholeData[source]: docs here!

traversal(folder_path: str, append_to_db: bool = True, store_sanity_data: bool = True, store_raw_data: bool = True, remove_source: bool = True, return_whole_data_list: bool = True) → List[WholeData] | None[source]: Traverse folder_path and return a list contains WholeData for each file in the folder_path. Note: This function does not traverse inner folders.

Data Reader

class mymoney.core.raw_data_reader.RawData(path: str, institution_name: str, service_name: str, account_name: str, input_df: DataFrame)[source]

docs here!

institution_executer() → TransformedData[source]: docs here!

class mymoney.core.raw_data_reader.RawDataReader[source]

Main class for reading data.

data_reader(path: str) → RawData[source]: Read the data in the path and returns a DataFrame with the Institution name and it’s service.

institutions

Base Class

class mymoney.institutions.institution_base.Institution[source]

docs here!

credit(input_df: DataFrame, account_name: str) → TransformedData[source]: docs here!

debit(input_df: DataFrame, account_name: str) → TransformedData[source]: docs here!

exchange(input_df: DataFrame, account_name: str) → TransformedData[source]: docs here!

third_party(input_df: DataFrame, account_name: str) → TransformedData[source]: docs here!

class mymoney.institutions.institution_base.TransformedData(sanity_df: DataFrame, output_df: DataFrame, out_type: str)[source]: docs here!

Institutions

class mymoney.institutions.amex.AmEx[source]: docs here!

class mymoney.institutions.capitalone.CapitalOne[source]: docs here!

class mymoney.institutions.chase.Chase[source]: docs here!

class mymoney.institutions.citi.Citi[source]: docs here!

class mymoney.institutions.discover.Discover[source]: docs here!

class mymoney.institutions.paypal.PayPal[source]: docs here!

class mymoney.institutions.venmo.Venmo[source]: docs here!

API

analysis

core

Data Classes

Data Operations

Executer

Data Reader

institutions

Base Class

Institutions

utils