# prefect-stitch
## Welcome!
Prefect collection to interact with Stitch
## Getting Started
### Python setup
Requires an installation of Python 3.7+.
We recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.
These tasks are designed to work with Prefect 2.0. For more information about how to use Prefect, please refer to the [Prefect documentation](https://orion-docs.prefect.io/).
### Installation
Install `prefect-stitch` with `pip`:
```bash
pip install prefect-stitch
```
### Write and run a flow
```python
from pydantic import SecretStr
from prefect import flow
from prefect_stitch.credentials import StitchCredentials
from prefect_stitch.tasks import (
start_replication_job
)
@flow
def example_flow():
creds = StitchCredentials(
access_token=SecretStr("my_secret_token")
)
start_replication_job(
credentials=creds,
source_id=1234
)
example_flow()
```
## Resources
If you encounter any bugs while using `prefect-stitch`, feel free to open an issue in the [prefect-stitch](https://github.com/AlessandroLollo/prefect-stitch) repository.
If you have any questions or issues while using `prefect-stitch`, you can find help in either the [Prefect Discourse forum](https://discourse.prefect.io/) or the [Prefect Slack community](https://prefect.io/slack).
## Development
If you'd like to install a version of `prefect-stitch` for development, clone the repository and perform an editable install with `pip`:
```bash
git clone https://github.com/AlessandroLollo/prefect-stitch.git
cd prefect-stitch/
pip install -e ".[dev]"
# Install linting pre-commit hooks
pre-commit install
```
Raw data
{
"_id": null,
"home_page": "https://github.com/AlessandroLollo/prefect-stitch",
"name": "prefect-stitch",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "prefect",
"author": "Alessandro Lollo",
"author_email": "alessandro.lollo@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c5/73/13db798934cc71c166c9f39a0f99bf06c11cec31687bb8590f6bdcec0c5b/prefect-stitch-0.1.4.tar.gz",
"platform": null,
"description": "# prefect-stitch\n\n## Welcome!\n\nPrefect collection to interact with Stitch\n\n## Getting Started\n\n### Python setup\n\nRequires an installation of Python 3.7+.\n\nWe recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.\n\nThese tasks are designed to work with Prefect 2.0. For more information about how to use Prefect, please refer to the [Prefect documentation](https://orion-docs.prefect.io/).\n\n### Installation\n\nInstall `prefect-stitch` with `pip`:\n\n```bash\npip install prefect-stitch\n```\n\n### Write and run a flow\n\n```python\nfrom pydantic import SecretStr\nfrom prefect import flow\nfrom prefect_stitch.credentials import StitchCredentials\nfrom prefect_stitch.tasks import (\n start_replication_job\n)\n\n\n@flow\ndef example_flow():\n creds = StitchCredentials(\n access_token=SecretStr(\"my_secret_token\")\n )\n start_replication_job(\n credentials=creds,\n source_id=1234\n )\n\nexample_flow()\n```\n\n## Resources\n\nIf you encounter any bugs while using `prefect-stitch`, feel free to open an issue in the [prefect-stitch](https://github.com/AlessandroLollo/prefect-stitch) repository.\n\nIf you have any questions or issues while using `prefect-stitch`, you can find help in either the [Prefect Discourse forum](https://discourse.prefect.io/) or the [Prefect Slack community](https://prefect.io/slack).\n\n## Development\n\nIf you'd like to install a version of `prefect-stitch` for development, clone the repository and perform an editable install with `pip`:\n\n```bash\ngit clone https://github.com/AlessandroLollo/prefect-stitch.git\n\ncd prefect-stitch/\n\npip install -e \".[dev]\"\n\n# Install linting pre-commit hooks\npre-commit install\n```\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Prefect collection to interact with Stitch",
"version": "0.1.4",
"split_keywords": [
"prefect"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "22951360afaca4664e8878c0609a80c9",
"sha256": "2f9a3947f12779dc7ab037cf88b5b2b2107c1e9aa07c77e0e721f8e0f7194172"
},
"downloads": -1,
"filename": "prefect_stitch-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "22951360afaca4664e8878c0609a80c9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9961,
"upload_time": "2022-12-15T14:18:47",
"upload_time_iso_8601": "2022-12-15T14:18:47.272250Z",
"url": "https://files.pythonhosted.org/packages/f0/2c/b6bd1e88c81e92865d788ef6b299352c63fa20ea266b45162b024ad9d84d/prefect_stitch-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "afaf04f0c5fdc5782ce57ac3bb0c4fff",
"sha256": "4643fccdb391ae1528b589666b42f93a88ff76c6f81ec74ccc5ac0f10904cbe6"
},
"downloads": -1,
"filename": "prefect-stitch-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "afaf04f0c5fdc5782ce57ac3bb0c4fff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 25819,
"upload_time": "2022-12-15T14:18:48",
"upload_time_iso_8601": "2022-12-15T14:18:48.479338Z",
"url": "https://files.pythonhosted.org/packages/c5/73/13db798934cc71c166c9f39a0f99bf06c11cec31687bb8590f6bdcec0c5b/prefect-stitch-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-15 14:18:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "AlessandroLollo",
"github_project": "prefect-stitch",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "prefect-stitch"
}
JSON
