PyHodl  0.2.7
Framework to download, update, analyze and plot your crypto-transactions. Completely off-line and security-oriented.
pyhodl.data.parse.core.CryptoParser Class Reference

Public Member Functions

def __init__ (self, input_file)
 
def get_raw_data (self)
 
def is_trade (self, raw)
 
def is_deposit (self, raw)
 
def is_withdrawal (self, raw)
 
def get_commission (self, raw)
 
def get_coins_amount_moved (self, raw)
 
def get_coins_amounts (self, raw)
 
def get_coin_moved (self, raw, coin_key="coin", amount_key="amount")
 
def get_date (self, raw)
 
def is_successful (self, raw)
 
def get_transaction_type (self, raw)
 
def parse_transaction (self, raw)
 
def get_transactions_list (self)
 
def build_exchange (self, exchange_name)
 

Static Public Member Functions

def get_coins_amount_traded (raw)
 

Public Attributes

 input_file
 
 filename
 

Detailed Description

Abstract parser 

Constructor & Destructor Documentation

def pyhodl.data.parse.core.CryptoParser.__init__ (   self,
  input_file 
)
:param input_file: str
    File to parse

Member Function Documentation

def pyhodl.data.parse.core.CryptoParser.build_exchange (   self,
  exchange_name 
)
:param exchange_name: str
    Name of exchange
:return: CryptoExchange
    List of transactions listed in a exchange
def pyhodl.data.parse.core.CryptoParser.get_coin_moved (   self,
  raw,
  coin_key = "coin",
  amount_key = "amount" 
)
:param raw: {}
    Raw details of transaction
:param coin_key: str
    Identify coin name in raw data
:param amount_key: str
    Identify coin amount in raw data
:return: tuple (str, float)
    Coin name and amount moved
def pyhodl.data.parse.core.CryptoParser.get_coins_amount_moved (   self,
  raw 
)
:param raw: {}
    Raw details of transaction
:return: tuple (str, float, str, float)
    Coin bought, amount bought, coin sold, amount sold in case of
    deposit/withdraw data
def pyhodl.data.parse.core.CryptoParser.get_coins_amount_traded (   raw)
static
:param raw: {}
    Raw details of transaction
:return: tuple (str, float, str, float)
    Coin bought, amount bought, coin sold, amount sold in case of
    trading data
def pyhodl.data.parse.core.CryptoParser.get_coins_amounts (   self,
  raw 
)
:param raw: {}
    Raw details of transaction
:return: tuple (str, float, str, float)
    Coin bought, amount bought, coin sold, amount sold
def pyhodl.data.parse.core.CryptoParser.get_commission (   self,
  raw 
)
:param raw: {}
    Raw trade
:return: Transaction
    Inner commission of transaction (if any). Commission values
    should always be positive floats.
def pyhodl.data.parse.core.CryptoParser.get_date (   self,
  raw 
)
:param raw: {}
    Raw details of transaction
:return: datetime
    Date and time of transaction
def pyhodl.data.parse.core.CryptoParser.get_raw_data (   self)
:return: [] of {}
    List of data from file
def pyhodl.data.parse.core.CryptoParser.get_transaction_type (   self,
  raw 
)
:param raw: {}
    Raw details of transaction
:return: TransactionType
    Type of transaction
def pyhodl.data.parse.core.CryptoParser.get_transactions_list (   self)
:return: [] of Transaction
    List of transactions of exchange
def pyhodl.data.parse.core.CryptoParser.is_deposit (   self,
  raw 
)
:param raw: {}
    Raw trade
:return: bool
    True iff data is a deposit
def pyhodl.data.parse.core.CryptoParser.is_successful (   self,
  raw 
)
:param raw: {}
    Raw details of transaction
:return: bool
    True iff transaction has completed successfully
def pyhodl.data.parse.core.CryptoParser.is_trade (   self,
  raw 
)
:param raw: {}
    Raw trade
:return: bool
    True iff data is a trading
def pyhodl.data.parse.core.CryptoParser.is_withdrawal (   self,
  raw 
)
:param raw: {}
    Raw trade
:return: bool
    True iff data is a withdrawal
def pyhodl.data.parse.core.CryptoParser.parse_transaction (   self,
  raw 
)
:param raw: {}
    Raw trade
:return: Transaction
    Parsed Transaction

Member Data Documentation

pyhodl.data.parse.core.CryptoParser.filename
pyhodl.data.parse.core.CryptoParser.input_file

The documentation for this class was generated from the following file: