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.17.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6cc6c9bfe7da8352f01e96c7427bfe1eff43ec55e47f4953a4ac419ede573e2 |
|
MD5 | ba4c63eee36feefd38174fcedac1e763 |
|
BLAKE2b-256 | a7a65613e9110327c3190f94192d1a88a440da8a2ab6495376792633e994a6d6 |
Close
Hashes for fyle_integrations_platform_connector-1.17.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2bea4749689e0038fa53d118a935a6cdb51b05e2b61a406561337e89e64141e3 |
|
MD5 | 6d1daab467eda4dd45a670c5618e8fb8 |
|
BLAKE2b-256 | de60967c6e9685e063ee7d684d47e102eed605cf349c0a4f7b10f68b1aaf6991 |