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)
# 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-1.27.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 094189b2fedd8fefd89667497a6514671c73be8fb043bd26e62989e555cb0f21 |
|
MD5 | c2bbe7cbedb79b3c0d0a172758a813a8 |
|
BLAKE2b-256 | dfb395a899d4f9a1c7ee6f02c4acb075c6bd65298a0f5567d7a5047a2a37ca42 |
Close
Hashes for fyle_integrations_platform_connector-1.27.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6906906b69f76bde98f8d521dc140305ac027840e092954701e58d1e2df741ef |
|
MD5 | 27bf54319427d21d6cecd2e16f2db2c0 |
|
BLAKE2b-256 | 382a23eacfab2fe1396f227a7e74c2c0212a4cb074bd23aaaf3ee56255494c34 |