fyle-integrations-platform-connector

v1.39.2

A common platform connector for all the Fyle Integrations to interact with Fyle Platform APIs For more information about how to use this package see README

Latest version published 18 days ago

License: MIT

PyPI

GitHub

Package Health Score

62 / 100

security
Security review needed
popularity
Small
maintenance
Healthy
community
Limited

Explore Similar Packages

concur
54

Popularity

Small

GitHub Stars: 0
Forks: 0
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package fyle-integrations-platform-connector, we found that it has been starred ? times.

Security

Security review needed

Security and license risk for latest version

Release Date: Oct 14, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
1
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like fyle-integrations-platform-connector is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 0
Open PR: 1
Last Release: 18 days ago
Last Commit: 4 months ago

Further analysis of the maintenance status of fyle-integrations-platform-connector based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that fyle-integrations-platform-connector demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the fyle-integrations-platform-connector repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like fyle-integrations-platform-connector is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: ==3.*

Age: 3 years
Latest Release: 18 days ago
Dependencies: 0 Direct
Versions: 76
Maintainers: 1
Wheels: OS Independent

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)

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;

FAQs

What is fyle-integrations-platform-connector?

A common platform connector for all the Fyle Integrations to interact with Fyle Platform APIs. Visit Snyk Advisor to see a full health score report for fyle-integrations-platform-connector, including popularity, security, maintenance & community analysis.

Is fyle-integrations-platform-connector popular?

The python package fyle-integrations-platform-connector receives a total of 1,539 weekly downloads. As such, fyle-integrations-platform-connector popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is fyle-integrations-platform-connector well maintained?

We found that fyle-integrations-platform-connector demonstrated a healthy version release cadence and project activity. It has a community of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is fyle-integrations-platform-connector safe to use?

While scanning the latest version of fyle-integrations-platform-connector, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 27 October-2024, at 13:18 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP