Skip to content

Connectors for interacting with popular APIs and services used in marketing analytics via clean and concise Python code.

License

Notifications You must be signed in to change notification settings

route1io/route1io-python-connectors

Repository files navigation

route1.io Python connectors

Issues License Version


At route1.io we've written high level, easy-to-use abstractions in Python for connecting to common APIs used in marketing analytics. This repository contains our official code, documentation, and tutorials to help you on your way accessing what matters most: your data.

Sample gif showing importing the connectors

Table of Contents


Supported API's

Below is a list of API's currently supported by our custom connectors


Installation

pip

Easily install to your environment from PyPI with

$ pip install route1io-connectors

Sample usage

All connectors provided by the package can be imported with Python's standard import syntax. See our wiki for tutorials regarding specific platform connectors!

from route1io_connectors import aws

# Credentials 
# NOTE: Storing credentials in source isn't secure in practice. 
#       It's recommended you store them in a more secure place.
AWS_ACCESS_KEY_ID = "YOUR_AWS_ACCESS_KEY_ID"
AWS_SECRET_ACCESS_KEY = "YOUR_AWS_SECRET_ACCESS_KEY"
REGION_NAME = "YOUR_DEFAULT_REGION_NAME"

# Connect to S3 
s3 = aws.connect_to_S3(
    aws_access_key_id=AWS_ACCESS_KEY_ID,
    aws_secret_access_key=AWS_SECRET_ACCESS_KEY,
    region_name=REGION_NAME
)

# Download remote file from S3 bucket to local machine
aws.download_from_S3(
    s3=s3,
    bucket="your.s3.bucket",
    key="local_file.csv"
    local_fpath="tmp/local_file.csv",
)

Documentation

Documentation can be found in docs/_build/html or online at Read The Docs

License

This library operates under the GNU GPL v3.0 license.