Skip to main content

A local client to work with Airbyte Cloud

Project description

shipyard-airbyte

Description

A local client to trigger Airbyte syncs and check statuses of past jobs

Installation

python3 -m pip install shipyard-airbyte

Usage

Establish the client by running the following

from shipyard_airbyte import AirbyteClient
ac = AirbyteClient(access_token = '<your_api_token>')
Trigger Syncs

To trigger a sync, you will need to provide the connector id to the trigger_sync method, which will return the json response from the API

sync_response = ac.trigger_sync(connection_id = '<your_connection_id>')
print(sync_response)
Sync Status

To verify the status of a past sync, you will need the jobId. This can be found from the sync_response shown above:

sync_response = ac.trigger_sync(connection_id = '<your_connection_id>')
job_id = sync_response['jobId']

sync_status = ac.get_sync_status(job_id)
print(sync_status)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shipyard_airbyte-0.1.6.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

shipyard_airbyte-0.1.6-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file shipyard_airbyte-0.1.6.tar.gz.

File metadata

  • Download URL: shipyard_airbyte-0.1.6.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.9.17 Darwin/22.5.0

File hashes

Hashes for shipyard_airbyte-0.1.6.tar.gz
Algorithm Hash digest
SHA256 d0f0ef38a8ef4bfe7dd30c2e355d43ea0262c5ecb2e29db23cd29538d1346a2c
MD5 ba67c3fba497a474434a3b690f9b1985
BLAKE2b-256 5633ada70323db1f99204c083c8dbd8e17bc696cf16a2b2b3cbc116abb4d19d6

See more details on using hashes here.

File details

Details for the file shipyard_airbyte-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for shipyard_airbyte-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 7cd4b3b6aa4d0b8af3e36ae1310bb51555f2997577a9c1faa60e3d463703079b
MD5 b54bc333bdf09d27e5acf6b87a115a7c
BLAKE2b-256 c309759919702639907f24a4ad25117e90839b63b79e21ba4fdaf7a7e0db13a2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page