| Name | prefect-gitlab JSON |
| Version |
0.2.3
JSON |
| download |
| home_page | None |
| Summary | A Prefect collection for working with GitLab repositories. |
| upload_time | 2024-04-25 19:22:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Apache License 2.0 |
| keywords |
prefect
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# prefect-gitlab
<p align="center">
<a href="https://pypi.python.org/pypi/prefect-gitlab/" alt="PyPI version">
<img alt="PyPI" src="https://img.shields.io/pypi/v/prefect-gitlab?color=26272B&labelColor=090422"></a>
<a href="https://pepy.tech/badge/prefect-gitlab/" alt="Downloads">
<img src="https://img.shields.io/pypi/dm/prefect-gitlab?color=26272B&labelColor=090422" /></a>
</p>
## Welcome!
`prefect-gitlab` is a Prefect collection for working with GitLab repositories.
## Getting Started
### Python setup
Requires an installation of Python 3.8 or higher.
We recommend using a Python virtual environment manager such as pipenv, conda, or virtualenv.
This integration is designed to work with Prefect 2.3.0 or higher. For more information about how to use Prefect, please refer to the [Prefect documentation](https://docs.prefect.io/).
### Installation
Install `prefect-gitlab` with `pip`:
```bash
pip install prefect-gitlab
```
Then, register the [block types](https://docs.prefect.io/concepts/blocks/)) in this integration to view the storage block type on Prefect Cloud:
```bash
prefect block register -m prefect_gitlab
```
Note, to use the `load` method on a block, you must already have a block document [saved](https://docs.prefect.io/concepts/blocks/).
## Creating a GitLab storage block
### In Python
```python
from prefect_gitlab import GitLabRepository
# public GitLab repository
public_gitlab_block = GitLabRepository(
name="my-gitlab-block",
repository="https://gitlab.com/testing/my-repository.git"
)
public_gitlab_block.save()
# specific branch or tag of a GitLab repository
branch_gitlab_block = GitLabRepository(
name="my-gitlab-block",
reference="branch-or-tag-name",
repository="https://gitlab.com/testing/my-repository.git"
)
branch_gitlab_block.save()
# Get all history of a specific branch or tag of a GitLab repository
branch_gitlab_block = GitLabRepository(
name="my-gitlab-block",
reference="branch-or-tag-name",
git_depth=None,
repository="https://gitlab.com/testing/my-repository.git"
)
branch_gitlab_block.save()
# private GitLab repository
private_gitlab_block = GitLabRepository(
name="my-private-gitlab-block",
repository="https://gitlab.com/testing/my-repository.git",
access_token="YOUR_GITLAB_PERSONAL_ACCESS_TOKEN"
)
private_gitlab_block.save()
```
Raw data
{
"_id": null,
"home_page": null,
"name": "prefect-gitlab",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "prefect",
"author": null,
"author_email": "\"Prefect Technologies, Inc.\" <help@prefect.io>",
"download_url": "https://files.pythonhosted.org/packages/48/51/e2144396aa34ea7fe3768770dc614691e8952630492405282400094c4254/prefect_gitlab-0.2.3.tar.gz",
"platform": null,
"description": "# prefect-gitlab\n\n<p align=\"center\">\n <a href=\"https://pypi.python.org/pypi/prefect-gitlab/\" alt=\"PyPI version\">\n <img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/prefect-gitlab?color=26272B&labelColor=090422\"></a>\n <a href=\"https://pepy.tech/badge/prefect-gitlab/\" alt=\"Downloads\">\n <img src=\"https://img.shields.io/pypi/dm/prefect-gitlab?color=26272B&labelColor=090422\" /></a>\n</p>\n\n## Welcome!\n\n`prefect-gitlab` is a Prefect collection for working with GitLab repositories.\n\n## Getting Started\n\n### Python setup\n\nRequires an installation of Python 3.8 or higher.\n\nWe recommend using a Python virtual environment manager such as pipenv, conda, or virtualenv.\n\nThis integration is designed to work with Prefect 2.3.0 or higher. For more information about how to use Prefect, please refer to the [Prefect documentation](https://docs.prefect.io/).\n\n### Installation\n\nInstall `prefect-gitlab` with `pip`:\n\n```bash\npip install prefect-gitlab\n```\n\nThen, register the [block types](https://docs.prefect.io/concepts/blocks/)) in this integration to view the storage block type on Prefect Cloud:\n\n```bash\nprefect block register -m prefect_gitlab\n```\n\nNote, to use the `load` method on a block, you must already have a block document [saved](https://docs.prefect.io/concepts/blocks/).\n\n## Creating a GitLab storage block\n\n### In Python\n\n```python\nfrom prefect_gitlab import GitLabRepository\n\n# public GitLab repository\npublic_gitlab_block = GitLabRepository(\n name=\"my-gitlab-block\",\n repository=\"https://gitlab.com/testing/my-repository.git\"\n)\n\npublic_gitlab_block.save()\n\n\n# specific branch or tag of a GitLab repository\nbranch_gitlab_block = GitLabRepository(\n name=\"my-gitlab-block\",\n reference=\"branch-or-tag-name\",\n repository=\"https://gitlab.com/testing/my-repository.git\"\n)\n\nbranch_gitlab_block.save()\n\n\n# Get all history of a specific branch or tag of a GitLab repository\nbranch_gitlab_block = GitLabRepository(\n name=\"my-gitlab-block\",\n reference=\"branch-or-tag-name\",\n git_depth=None,\n repository=\"https://gitlab.com/testing/my-repository.git\"\n)\n\nbranch_gitlab_block.save()\n\n# private GitLab repository\nprivate_gitlab_block = GitLabRepository(\n name=\"my-private-gitlab-block\",\n repository=\"https://gitlab.com/testing/my-repository.git\",\n access_token=\"YOUR_GITLAB_PERSONAL_ACCESS_TOKEN\"\n)\n\nprivate_gitlab_block.save()\n```\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "A Prefect collection for working with GitLab repositories.",
"version": "0.2.3",
"project_urls": {
"Homepage": "https://github.com/PrefectHQ/prefect/tree/main/src/integrations/prefect-gitlab"
},
"split_keywords": [
"prefect"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "05ec6b923a7b03bdfd2a0d36192488c1bd1beaf99733c633e7e9e0003a5d3aca",
"md5": "ee1671c12a469a4320d120963e7b7d3e",
"sha256": "f0e70ce258f0ac24ec372dcc96661544a15bcf66f2876dc357a83011a24a7e17"
},
"downloads": -1,
"filename": "prefect_gitlab-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ee1671c12a469a4320d120963e7b7d3e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7106,
"upload_time": "2024-04-25T19:22:18",
"upload_time_iso_8601": "2024-04-25T19:22:18.424582Z",
"url": "https://files.pythonhosted.org/packages/05/ec/6b923a7b03bdfd2a0d36192488c1bd1beaf99733c633e7e9e0003a5d3aca/prefect_gitlab-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4851e2144396aa34ea7fe3768770dc614691e8952630492405282400094c4254",
"md5": "691be80df60afca04d69c1979004b882",
"sha256": "a8157f913c5ee35eef06341cd8f4ba97c4daf20052aaff83c3d5874046344704"
},
"downloads": -1,
"filename": "prefect_gitlab-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "691be80df60afca04d69c1979004b882",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8867,
"upload_time": "2024-04-25T19:22:19",
"upload_time_iso_8601": "2024-04-25T19:22:19.845879Z",
"url": "https://files.pythonhosted.org/packages/48/51/e2144396aa34ea7fe3768770dc614691e8952630492405282400094c4254/prefect_gitlab-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-25 19:22:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PrefectHQ",
"github_project": "prefect",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"circle": true,
"requirements": [],
"lcname": "prefect-gitlab"
}
