# prefect-lakefs
<p align="center">
<!--- Insert a cover image here -->
<!--- <br> -->
<a href="https://pypi.python.org/pypi/prefect-lakefs/" alt="PyPI version">
<img alt="PyPI" src="https://img.shields.io/pypi/v/prefect-lakefs?color=0052FF&labelColor=090422"></a>
<a href="https://github.com/limx0/prefect-lakefs/" alt="Stars">
<img src="https://img.shields.io/github/stars/limx0/prefect-lakefs?color=0052FF&labelColor=090422" /></a>
<a href="https://pypistats.org/packages/prefect-lakefs/" alt="Downloads">
<img src="https://img.shields.io/pypi/dm/prefect-lakefs?color=0052FF&labelColor=090422" /></a>
<a href="https://github.com/limx0/prefect-lakefs/pulse" alt="Activity">
<img src="https://img.shields.io/github/commit-activity/m/limx0/prefect-lakefs?color=0052FF&labelColor=090422" /></a>
<br>
<a href="https://prefect-community.slack.com" alt="Slack">
<img src="https://img.shields.io/badge/slack-join_community-red.svg?color=0052FF&labelColor=090422&logo=slack" /></a>
<a href="https://discourse.prefect.io/" alt="Discourse">
<img src="https://img.shields.io/badge/discourse-browse_forum-red.svg?color=0052FF&labelColor=090422&logo=discourse" /></a>
</p>
Visit the full docs [here](https://limx0.github.io/prefect-lakefs) to see additional examples and the API reference.
Prefect integrations for interacting with LakeFS services.
## Welcome!
`prefect-lakefs` is a collection of Prefect tasks and flows which can be used to interact with lakeFS managed datalakes.
Jump to [examples](#example-usage).
## Resources
For more tips on how to use tasks and flows in a Collection, check out [Using Collections](https://docs.prefect.io/collections/usage/)!
### Installation
Install `prefect-lakefs` with `pip`:
```bash
pip install prefect-lakefs
```
Requires an installation of Python 3.8+.
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://docs.prefect.io/).
### Example Usage
#### Configure LakeFS Credentials and dive in.
```python
import asyncio
from prefect_lakefs.credentials import LakeFSCredentials
from prefect_lakefs.tasks import list_branches
# You can configure this while adding a block in the prefect-ui or
# you can save the block using .save() utility method provided by the block.
lakefs_creds = LakeFSCredentials(
endpoint_url="http://localhost:8000/api/v1",
access_key_id="AKIAIOSFODNN7EXAMPLE",
secret_access_key="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
).save("lakefs-creds")
@flow
def list_branches_for_example_repo():
branches = list_branches(
lakefs_credentials=LakeFSCredentials.load("lakefs-creds"),
repository="example",
)
print(branches)
if __name__ == "__main__":
# run the flow
asyncio.run(list_branches())
```
### Feedback
If you encounter any bugs while using `prefect-lakefs`, feel free to open an issue in the [prefect-lakefs](https://github.com/limx0/prefect-lakefs) repository.
If you have any questions or issues while using `prefect-lakefs`, you can find help in either the [Prefect Discourse forum](https://discourse.prefect.io/) or the [Prefect Slack community](https://prefect.io/slack) or the [LakeFS Slack Community](https://go.lakefs.io/JoinSlack).
Feel free to star or watch [`prefect-lakefs`](https://github.com/limx0/prefect-lakefs) for updates too!
### Contributing
If you'd like to help contribute to fix an issue or add a feature to `prefect-lakefs`, please [propose changes through a pull request from a fork of the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
Here are the steps:
1. [Fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository)
2. [Clone the forked repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository)
3. Install the repository and its dependencies:
```
pip install -e ".[dev]"
```
4. Make desired changes
5. Add tests
6. Insert an entry to [CHANGELOG.md](https://github.com/limx0/prefect-lakefs/blob/main/CHANGELOG.md)
7. Install `pre-commit` to perform quality checks prior to commit:
```
pre-commit install
```
8. `git commit`, `git push`, and create a pull request
Raw data
{
"_id": null,
"home_page": "https://github.com/limx0/prefect-lakefs",
"name": "prefect-lakefs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "prefect",
"author": "limx0",
"author_email": "limx0@example.com",
"download_url": "https://files.pythonhosted.org/packages/76/5a/ae616c47580517da0988f80f75c373a44b2fda62c06b4267a052ca369a4d/prefect-lakefs-0.4.0.tar.gz",
"platform": null,
"description": "# prefect-lakefs\n\n<p align=\"center\">\n <!--- Insert a cover image here -->\n <!--- <br> -->\n <a href=\"https://pypi.python.org/pypi/prefect-lakefs/\" alt=\"PyPI version\">\n <img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/prefect-lakefs?color=0052FF&labelColor=090422\"></a>\n <a href=\"https://github.com/limx0/prefect-lakefs/\" alt=\"Stars\">\n <img src=\"https://img.shields.io/github/stars/limx0/prefect-lakefs?color=0052FF&labelColor=090422\" /></a>\n <a href=\"https://pypistats.org/packages/prefect-lakefs/\" alt=\"Downloads\">\n <img src=\"https://img.shields.io/pypi/dm/prefect-lakefs?color=0052FF&labelColor=090422\" /></a>\n <a href=\"https://github.com/limx0/prefect-lakefs/pulse\" alt=\"Activity\">\n <img src=\"https://img.shields.io/github/commit-activity/m/limx0/prefect-lakefs?color=0052FF&labelColor=090422\" /></a>\n <br>\n <a href=\"https://prefect-community.slack.com\" alt=\"Slack\">\n <img src=\"https://img.shields.io/badge/slack-join_community-red.svg?color=0052FF&labelColor=090422&logo=slack\" /></a>\n <a href=\"https://discourse.prefect.io/\" alt=\"Discourse\">\n <img src=\"https://img.shields.io/badge/discourse-browse_forum-red.svg?color=0052FF&labelColor=090422&logo=discourse\" /></a>\n</p>\n\nVisit the full docs [here](https://limx0.github.io/prefect-lakefs) to see additional examples and the API reference.\n\nPrefect integrations for interacting with LakeFS services.\n\n\n## Welcome!\n\n`prefect-lakefs` is a collection of Prefect tasks and flows which can be used to interact with lakeFS managed datalakes.\n\nJump to [examples](#example-usage).\n\n\n## Resources\n\nFor more tips on how to use tasks and flows in a Collection, check out [Using Collections](https://docs.prefect.io/collections/usage/)!\n\n### Installation\n\nInstall `prefect-lakefs` with `pip`:\n\n```bash\npip install prefect-lakefs\n```\n\nRequires an installation of Python 3.8+.\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://docs.prefect.io/).\n\n### Example Usage\n\n#### Configure LakeFS Credentials and dive in.\n\n```python\nimport asyncio\n\nfrom prefect_lakefs.credentials import LakeFSCredentials\nfrom prefect_lakefs.tasks import list_branches\n\n# You can configure this while adding a block in the prefect-ui or\n# you can save the block using .save() utility method provided by the block.\nlakefs_creds = LakeFSCredentials(\n endpoint_url=\"http://localhost:8000/api/v1\",\n access_key_id=\"AKIAIOSFODNN7EXAMPLE\",\n secret_access_key=\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\n ).save(\"lakefs-creds\")\n\n\n@flow\ndef list_branches_for_example_repo():\n branches = list_branches(\n lakefs_credentials=LakeFSCredentials.load(\"lakefs-creds\"),\n repository=\"example\",\n )\n print(branches)\n\n\n\nif __name__ == \"__main__\":\n # run the flow\n asyncio.run(list_branches())\n```\n\n\n### Feedback\n\nIf you encounter any bugs while using `prefect-lakefs`, feel free to open an issue in the [prefect-lakefs](https://github.com/limx0/prefect-lakefs) repository.\n\nIf you have any questions or issues while using `prefect-lakefs`, you can find help in either the [Prefect Discourse forum](https://discourse.prefect.io/) or the [Prefect Slack community](https://prefect.io/slack) or the [LakeFS Slack Community](https://go.lakefs.io/JoinSlack).\n\nFeel free to star or watch [`prefect-lakefs`](https://github.com/limx0/prefect-lakefs) for updates too!\n\n### Contributing\n\nIf you'd like to help contribute to fix an issue or add a feature to `prefect-lakefs`, please [propose changes through a pull request from a fork of the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).\n\nHere are the steps:\n\n1. [Fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository)\n2. [Clone the forked repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository)\n3. Install the repository and its dependencies:\n```\npip install -e \".[dev]\"\n```\n4. Make desired changes\n5. Add tests\n6. Insert an entry to [CHANGELOG.md](https://github.com/limx0/prefect-lakefs/blob/main/CHANGELOG.md)\n7. Install `pre-commit` to perform quality checks prior to commit:\n```\npre-commit install\n```\n8. `git commit`, `git push`, and create a pull request\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Prefect integrations for interacting with LakeFS services.",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://github.com/limx0/prefect-lakefs"
},
"split_keywords": [
"prefect"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6da880c88e8cbb84c3688559006024f550a3f273cf277057a594c0df4ac3d662",
"md5": "71b99435ca452254ca6f77bd88ea4415",
"sha256": "39117de3888026ec4f7ace80cda1693ee8cf78fc88a3810aae42e236ff207e13"
},
"downloads": -1,
"filename": "prefect_lakefs-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "71b99435ca452254ca6f77bd88ea4415",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 19758,
"upload_time": "2023-10-21T07:44:35",
"upload_time_iso_8601": "2023-10-21T07:44:35.956535Z",
"url": "https://files.pythonhosted.org/packages/6d/a8/80c88e8cbb84c3688559006024f550a3f273cf277057a594c0df4ac3d662/prefect_lakefs-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "765aae616c47580517da0988f80f75c373a44b2fda62c06b4267a052ca369a4d",
"md5": "b37f1fb1c6abb817263be93bdaa2ff39",
"sha256": "de33da23b034998923637365d04d77594816493c5b6232d869c32dccc8e096e2"
},
"downloads": -1,
"filename": "prefect-lakefs-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "b37f1fb1c6abb817263be93bdaa2ff39",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 37980,
"upload_time": "2023-10-21T07:44:37",
"upload_time_iso_8601": "2023-10-21T07:44:37.416919Z",
"url": "https://files.pythonhosted.org/packages/76/5a/ae616c47580517da0988f80f75c373a44b2fda62c06b4267a052ca369a4d/prefect-lakefs-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-21 07:44:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "limx0",
"github_project": "prefect-lakefs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "prefect-lakefs"
}
JSON
