A common platform connector for all the Fyle Integrations to interact with Fyle Platform APIs
Project description
Fyle Integrations Platform Connector
Installation and Usage
A common platform connector for all the Fyle Integrations to interact with Fyle's Platform APIs
pip install fyle-integrations-platform-connector
In Django settings.py
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
# Installed Apps
'rest_framework',
'corsheaders',
'fyle_rest_auth', # already existing reusable django app for authentication
'fyle_accounting_mappings', # already existing mapping infra app,
'fyle_integrations_platform_connector', # new platform connector
# User Created Apps
'apps.users',
'apps.workspaces',
'apps.mappings',
'apps.fyle',
'apps.quickbooks_online',
'apps.tasks'
]
Usage
from fyle_integrations_platform_connector import PlatformConnector
connector = PlatformConnector(
fyle_credential=fyle_credential,
workspace_id=workspace_id
)
# Get Expenses
expenses = connector.expenses.get(
source_account_type=['PERSONAL_CASH_ACCOUNT', 'PERSONAL_CORPORATE_CREDIT_CARD_ACCOUNT'],
state='PAID',
last_synced_at='2021-08-22T00:00:000.000Z',
filter_credit_expenses=True
)
# Import Fyle dimensions
connector.import_fyle_dimensions()
# Import specific Fyle dimensions
connector.employees.sync()
connector.projects.sync()
Local Development
Setup
Setup virtual environment and install dependencies -
python3 -m venv venv && source venv/bin/activate && pip install -r requirements.txt
Copy sample secrets file and add secret environment variables -
cp sample_secrets.sh secrets.sh
Copy sample script file -
cp script.py raw_script.py
Run a raw python script (script.py)
bash run.sh
Open SQLITE db and check data
sqlite3 db.sqlite3
-- Example query
select attribute_type, count(*) from expense_attributes group by attribute_type;
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.
Source Distribution
Built Distribution
Close
Hashes for fyle-integrations-platform-connector-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7610ec58dbcbb44240baf1abda511aab0f9ff09b22b26710775dd81633ecfced |
|
MD5 | 9feb89ef6bb2edf4377db137f6fb7c7b |
|
BLAKE2b-256 | e3526d8598d8b685415c327c1c3ae08ea733f228b4db9660a829f661ae764358 |
Close
Hashes for fyle_integrations_platform_connector-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 990f0ad413b4423ac6758ecb0fb3d6520be7da69b3e59fee0ae5545479766271 |
|
MD5 | 1e877701bbef50520fffef7918bb8506 |
|
BLAKE2b-256 | b8cd34b34b90b4159fe76325fda7fc55d7339089603b01bfcf3c78c3aa977e8c |