Get financial data easily.
Project description
Fidap Python Client
This Fidap client interacts with our big data servers and gives you access to Financial data analytics.
NOTE: You can get api_key
from the Dashboard. Please contact ashishsingal1@gmail.com
for the invite code.
Installation
pip install fidap
Getting Started
from fidap import fidap_client
client = fidap_client(api_key="Paste API_KEY here from fidap dashboard")
you can also provide the database during initializing the client
from fidap import fidap_client
client = fidap_client(source='bq', api_key="Paste API_KEY here from fidap dashboard")
API
.sql
You can run your queries by using this method, it will return a Pandas dataframe containing the results of the query. Result would be None if something goes wrong i.e. incorrect query / not a valid API key.
from fidap import fidap_client
client = fidap_client(api_key="Paste API_KEY here from fidap dashboard")
df = client.sql(sql="paste your QUERY")
NOTE: You can also change the database at this level!
df = client.sql(sql="paste your QUERY", source="sf_gcp")
.send_email
You can send yourself or someone you know the Pandas dataframe as a csv attachment by using this method.
from fidap import fidap_client
client = fidap_client(api_key="Paste API_KEY here from fidap dashboard")
df = client.sql(sql="paste your QUERY")
success = client.send_email(df=df, emails=[]) #'List of Emails')
NOTE: By default, it will share the file containing 1000 rows and 30 columns only
.create_dataset
You can create dataset using this method and it can be seen on Dashboard
fidap.create_dataset(
name='xxx',
description='xxxx',
source='bq', project='xxxx',
dataset='xxxx',
public=False
)
.datasets
You can list dataset in json format by using this method
fidap.datasets(limit=100)
NOTE: By default, it will only 100 datasets you can increase the limit
.dataset
This method takes one argument dataset_id and returns a dict contains dataset info and related tables list
fidap.dataset(dataset_id)
.table
This method takes one argument table_id and returns a dict contains table info and its fields list
fidap.table(table_id)
.field
This method takes one argument field_id and returns object contains info about table field.
fidap.field(field_id)
.update_entity
This method takes 3 arguments entity name (dataset, table, field) and 2nd argument is entity's id and 3rd argument is dict, which attribute you want to update.
fidap.update_entity(
entity='dataset',
id=xxx,
values=dict(description="This dataset is very fascinating, fidap datasets are awesome")
)
.load_table_as_dataframe
Load table via delta share, df_type can be 'pandas' or 'spark'
fidap.load_table_as_dataframe(
share_name='xxx',
schema='xxx',
table_name='xxx',
df_type=pandas
)
Contributing
git clone https://github.com/fidapco/fidap-python-client.git
cd fidap-python-client
pip install --editable .
Change log
[0.0.1] - 2021-01-04
Initial version.
Added
fidap.sql()
runs a query on the Fidap DB.
Changed
Removed
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.