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.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0495e0d13d9b469369a72fe2d4630895c63f6aee2a3e561dbc0a811f8479d5e7 |
|
MD5 | afa96afe74d5353be07fa7f12e24522a |
|
BLAKE2b-256 | 7fdbdd3800a44822fd9f6108f7fe117efd710069de814bc4c69a39b0eae786b8 |
Close
Hashes for fyle_integrations_platform_connector-1.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 62121a00887ea2c6d573b156ff9fdaf5191ebcfaa56077cde95019009dfc2d7e |
|
MD5 | 34be461dedb8a92aa6922de0e83c1555 |
|
BLAKE2b-256 | ba983d3aa03b4fb7165c9ba37858c1b56710a80909676f9bdec278dcae8838a4 |