Develop connectors for Element Unify with the Connector Framework
Project description
Element Unify Connector Framework
The Unify Python Connector Framework is a library to develop connectors that interact with Element Unify. This library is intended for developers who are building connectors to ingest source input data to Element Unify or publish data from Element Unify to another destination.
User Information
This section is intended for users of the Unify Python Connector Framework. This includes developers who are building connectors, integrations, and automation that interfaces with Element Unify. For developers looking to contribute to the Connector Framework, see the Developer Information section.
Installation
You can install the Unify Connector Framework from PyPI:
pip install unify-connector-framework
Using the Unify Connector Framework with virtualenv
This assumes you have installed an appropriate version virtualenv, python, and
other associated tools. This also assumes you have an existing python project
you'd like to import into, in this case my-project
.
mkdir path/to/my-project; cd path/to/my-project
virtualenv venv
source venv/bin/activate
echo unify-connector-framework >> requirements.txt
Then, in your python import section add the following line:
from unifyconnectorframework.organization_client import OrganizationClient
Documentation
The Connector Framework developer guide is found in the Unify API Documentation Portal under the Unify Connector Framework section.
- Navigate to your instance of Element Unify.
- Log in and select your organization.
- From the top-right menu, click on the Support icon and select API Documentation.
Developer Information
This section is intended for developers working to extend the Unify Connector Framework.
Developer Guide
- Fork this repository.
- Revise files with your contributions.
- Follow styling guides. See Python style guide.
- Check for lint warnings. See Lint checking.
- Create a pull request with description of your changes.
Python style guide
Please use the following Python style guide Google Python Styling guide
Lint checking
We usy pylint to verify lint warnings, our build system requires a linter score of >=9.0 to pass successfully.
To locally check you changes
pip install pylint
pylint dir/to/the/file.py
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
Hashes for unify-connector-framework-1.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e54a59cc8946fc7e2f07591002d8a195d83566086be07188c0c4340cd311cb6a |
|
MD5 | 55c4e59d69f39dbeada130d6a3958c28 |
|
BLAKE2b-256 | 00a98db0cec6867ad5fbcef80338bfce85c84d19d6fc88d3104db3688c526dbc |
Hashes for unify_connector_framework-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 153811fbdd7072238f8a855bcf30f505a6b9e49909bb3fad2c9c6a6c8c6eb1e5 |
|
MD5 | 8b4b137af863ee1c8da41e4a9c0b353d |
|
BLAKE2b-256 | 812b38f73a36ade6e56544250ba602edf7fd63093aff5a925062957d58edd37c |