https://github.com/fylein/fyle-integrations-platform-connector

A common platform connector for all the Fyle Integrations to interact with Fyle's Platform APIs
https://github.com/fylein/fyle-integrations-platform-connector

team-integrations

Last synced: about 2 months ago
JSON representation

A common platform connector for all the Fyle Integrations to interact with Fyle's Platform APIs

• Host: GitHub
• URL: https://github.com/fylein/fyle-integrations-platform-connector
• Owner: fylein
• License: mit
• Created: 2021-10-06T06:30:13.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-14T15:25:25.000Z (3 months ago)
• Last Synced: 2024-10-14T15:36:58.883Z (3 months ago)
• Topics: team-integrations
• Language: Python
• Size: 206 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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)](https://github.com/fylein/fyle-integrations-platform-connector/blob/master/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;

```