shipyard-coalesce

Name	shipyard-coalesce JSON
Version	0.2.1 JSON
	download
home_page	None
Summary	A local client for connecting and working with Coalesce
upload_time	2024-03-27 16:48:03
maintainer	None
docs_url	None
author	wrp801
requires_python	<4.0,>=3.9
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # shipyard-coalesce

## Description 
A local client to trigger Coalesce job's and check statuses of past runs

Installation 
`python3 -m pip install shipyard-coalesce`

## Usage
Establish the client by running the following

```python
from shipyard_coalesce import CoalesceClient
client = CoalesceClient(access_token = '<your_access_token>')
```

### Trigger syncs
The following arguments are required for the `trigger_sync` function:
- environment_id 
- snowflake_username
- snowflake_password
- snowflake_role

The following arguments are optional:
- snowflake_warehouse
- include_nodes_selector
- exclude_nodes_selector
- parallelism
- job_id

```python
response = client.trigger_sync(environment_id = environment_id, snowflake_username = snowflake_username, snowflake_password = snowflake_password, snowflake_role = snowflake_role)
print(response)
```

### Sync Status
To verify the sync status, you will need the `runID`, which is obtained in the response from the `trigger_sync` method. 

```python
run_id = response['runCounter']
status = client.get_run_status(run_id)
print(status.text)
```
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "shipyard-coalesce",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "wrp801",
    "author_email": "wespoulsen@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/3a/bc/896b905d0d6afc31e008817148533d529b529c727f4c123e4417be811a4c/shipyard_coalesce-0.2.1.tar.gz",
    "platform": null,
    "description": "# shipyard-coalesce\n\n## Description \nA local client to trigger Coalesce job's and check statuses of past runs\n\nInstallation \n`python3 -m pip install shipyard-coalesce`\n\n## Usage\nEstablish the client by running the following\n\n```python\nfrom shipyard_coalesce import CoalesceClient\nclient = CoalesceClient(access_token = '<your_access_token>')\n```\n\n### Trigger syncs\nThe following arguments are required for the `trigger_sync` function:\n- environment_id \n- snowflake_username\n- snowflake_password\n- snowflake_role\n\nThe following arguments are optional:\n- snowflake_warehouse\n- include_nodes_selector\n- exclude_nodes_selector\n- parallelism\n- job_id\n\n```python\nresponse = client.trigger_sync(environment_id = environment_id, snowflake_username = snowflake_username, snowflake_password = snowflake_password, snowflake_role = snowflake_role)\nprint(response)\n```\n\n### Sync Status\nTo verify the sync status, you will need the `runID`, which is obtained in the response from the `trigger_sync` method. \n\n```python\nrun_id = response['runCounter']\nstatus = client.get_run_status(run_id)\nprint(status.text)\n```",
    "bugtrack_url": null,
    "license": null,
    "summary": "A local client for connecting and working with Coalesce",
    "version": "0.2.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "07ab96de9a8514dd7950088853fdea903acaeefc76f4607d399175a9ac8a379d",
                "md5": "7a76da4480b8390b4a5c7cb1dbb09653",
                "sha256": "dd7d0b03c2dd1e87d0a557bdfd1e490383d60096dd09eb59fdd06639b60a3726"
            },
            "downloads": -1,
            "filename": "shipyard_coalesce-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7a76da4480b8390b4a5c7cb1dbb09653",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 6972,
            "upload_time": "2024-03-27T16:48:01",
            "upload_time_iso_8601": "2024-03-27T16:48:01.456193Z",
            "url": "https://files.pythonhosted.org/packages/07/ab/96de9a8514dd7950088853fdea903acaeefc76f4607d399175a9ac8a379d/shipyard_coalesce-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3abc896b905d0d6afc31e008817148533d529b529c727f4c123e4417be811a4c",
                "md5": "80e235aa4c5db8842ac48d3eace2f41f",
                "sha256": "2d5b17a03b27f192d01b33ed54b8042196d6c5acf702e5041ed173da89cfffc1"
            },
            "downloads": -1,
            "filename": "shipyard_coalesce-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "80e235aa4c5db8842ac48d3eace2f41f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 4945,
            "upload_time": "2024-03-27T16:48:03",
            "upload_time_iso_8601": "2024-03-27T16:48:03.102284Z",
            "url": "https://files.pythonhosted.org/packages/3a/bc/896b905d0d6afc31e008817148533d529b529c727f4c123e4417be811a4c/shipyard_coalesce-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-27 16:48:03",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "shipyard-coalesce"
}