shipyard-airbyte

Name	shipyard-airbyte JSON
Version	0.1.6 JSON
	download
home_page
Summary	A local client to work with Airbyte Cloud
upload_time	2023-08-21 23:19:26
maintainer
docs_url	None
author	wrp801
requires_python	>=3.9,<4.0
license	Apache-2.0
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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

```python 
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

```python
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:
```python
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)
```





            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "shipyard-airbyte",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "wrp801",
    "author_email": "wespoulsen@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/56/33/ada70323db1f99204c083c8dbd8e17bc696cf16a2b2b3cbc116abb4d19d6/shipyard_airbyte-0.1.6.tar.gz",
    "platform": null,
    "description": "# shipyard-airbyte\n\n## Description \nA local client to trigger Airbyte syncs and check statuses of past jobs\n\n### Installation\n\n`python3 -m pip install shipyard-airbyte` \n\n\n### Usage \nEstablish the client by running the following\n\n```python \nfrom shipyard_airbyte import AirbyteClient\nac = AirbyteClient(access_token = '<your_api_token>')\n```\n\n##### Trigger Syncs\nTo 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\n\n```python\nsync_response = ac.trigger_sync(connection_id = '<your_connection_id>')\nprint(sync_response)\n```\n\n##### Sync Status\nTo verify the status of a past sync, you will need the `jobId`. This can be found from the sync_response shown above:\n```python\nsync_response = ac.trigger_sync(connection_id = '<your_connection_id>')\njob_id = sync_response['jobId']\n\nsync_status = ac.get_sync_status(job_id)\nprint(sync_status)\n```\n\n\n\n\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "A local client to work with Airbyte Cloud",
    "version": "0.1.6",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c309759919702639907f24a4ad25117e90839b63b79e21ba4fdaf7a7e0db13a2",
                "md5": "b54bc333bdf09d27e5acf6b87a115a7c",
                "sha256": "7cd4b3b6aa4d0b8af3e36ae1310bb51555f2997577a9c1faa60e3d463703079b"
            },
            "downloads": -1,
            "filename": "shipyard_airbyte-0.1.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b54bc333bdf09d27e5acf6b87a115a7c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9,<4.0",
            "size": 5347,
            "upload_time": "2023-08-21T23:19:25",
            "upload_time_iso_8601": "2023-08-21T23:19:25.513507Z",
            "url": "https://files.pythonhosted.org/packages/c3/09/759919702639907f24a4ad25117e90839b63b79e21ba4fdaf7a7e0db13a2/shipyard_airbyte-0.1.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5633ada70323db1f99204c083c8dbd8e17bc696cf16a2b2b3cbc116abb4d19d6",
                "md5": "ba67c3fba497a474434a3b690f9b1985",
                "sha256": "d0f0ef38a8ef4bfe7dd30c2e355d43ea0262c5ecb2e29db23cd29538d1346a2c"
            },
            "downloads": -1,
            "filename": "shipyard_airbyte-0.1.6.tar.gz",
            "has_sig": false,
            "md5_digest": "ba67c3fba497a474434a3b690f9b1985",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9,<4.0",
            "size": 3804,
            "upload_time": "2023-08-21T23:19:26",
            "upload_time_iso_8601": "2023-08-21T23:19:26.996479Z",
            "url": "https://files.pythonhosted.org/packages/56/33/ada70323db1f99204c083c8dbd8e17bc696cf16a2b2b3cbc116abb4d19d6/shipyard_airbyte-0.1.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-21 23:19:26",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "shipyard-airbyte"
}