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 as PlatformIntegrationsConnector
connector = PlatformIntegrationsConnector(
cluster_domain=cluster_domain,
token_url=settings.FYLE_TOKEN_URI,
client_id=settings.FYLE_CLIENT_ID,
client_secret=settings.FYLE_CLIENT_SECRET,
refresh_token=refresh_token,
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
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.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9198b1ea613bc0979a96fb1353e07ff3c4e00d2d39ea4f456df7c894ce964e84 |
|
MD5 | 65fcb326ed0ddaf15a253182195fe061 |
|
BLAKE2b-256 | c2ca7772c42d149dc69f0e21ac188801030e2d77f01a3e695e4d508abf57e7db |
Close
Hashes for fyle_integrations_platform_connector-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f1901b050fc75837a984e07af3433967c5bd4adcf995565cbf766a2ee42290c |
|
MD5 | f583711fc7a82622e5c897cd21779d8f |
|
BLAKE2b-256 | aedb533d6cc851121cb4c8bad4a811101039df11dd44c8ea13e0e69703b25f22 |