Bitbucket Pipes Toolkit
=======================
This package contains various tools and helpers to make it more fun and easy for people to develop pipes. This includes improved colorized logging, shared data interface, array variables helpers and more.
Installation
============
`pip install bitbucket-pipes-toolkit`
Examples
========
Simple pipe example
```python3
import os
from bitbucket_pipes_toolkit import Pipe
class MyPipe(Pipe):
def run(self):
super().run()
print("I'm a simple little pipe")
# below is a simple schema for pipe variables.
schema = {'USERNAME': {'required': True, 'type': 'string'},
'PASSWORD': {'required': True, 'type': 'string'}}
pipe_metadata = {
'name': 'My Pipe',
'image': 'my-docker-image:latest'
}
# Set environment variables required in schema.
os.environ['USERNAME'] = 'user'
os.environ['PASSWORD'] = 'pwd'
my_pipe = MyPipe(pipe_metadata=pipe_metadata, schema=schema)
my_pipe.run()
```
Documentation
=============
For more details have a look at the [official documentation](https://bitbucket-pipes-toolkit.readthedocs.io).
Support
=======
If you’d like help with the toolkit, or you have an issue or feature request, let us know on [Community](https://community.atlassian.com/t5/forums/postpage/board-id/bitbucket-pipelines-questions?add-tags=pipes,toolkit).
If you’re reporting an issue, please include:
* the version of the toolkit
* relevant logs and error messages
* steps to reproduce
Raw data
{
"_id": null,
"home_page": null,
"name": "bitbucket-pipes-toolkit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Atlassian <bitbucketci-team@atlassian.com>",
"keywords": "bitbucket, bitbucket pipelines, bitbucket pipes, development",
"author": null,
"author_email": "Atlassian <bitbucketci-team@atlassian.com>, bitbucketci-team@atlassian.com",
"download_url": "https://files.pythonhosted.org/packages/44/78/b44a33275810dd767e982e37b5ef9213b6c3c5e655258906fc6a47fbf5c1/bitbucket_pipes_toolkit-5.0.2.tar.gz",
"platform": null,
"description": "Bitbucket Pipes Toolkit\n=======================\n\n\n\nThis package contains various tools and helpers to make it more fun and easy for people to develop pipes. This includes improved colorized logging, shared data interface, array variables helpers and more.\n\nInstallation\n============\n\n`pip install bitbucket-pipes-toolkit`\n\n\nExamples\n========\n\nSimple pipe example\n```python3\nimport os\n\nfrom bitbucket_pipes_toolkit import Pipe\n\n\nclass MyPipe(Pipe):\n def run(self):\n super().run()\n print(\"I'm a simple little pipe\")\n\n\n# below is a simple schema for pipe variables.\nschema = {'USERNAME': {'required': True, 'type': 'string'},\n 'PASSWORD': {'required': True, 'type': 'string'}}\n\npipe_metadata = {\n 'name': 'My Pipe',\n 'image': 'my-docker-image:latest'\n}\n\n# Set environment variables required in schema.\nos.environ['USERNAME'] = 'user'\nos.environ['PASSWORD'] = 'pwd'\n\nmy_pipe = MyPipe(pipe_metadata=pipe_metadata, schema=schema)\nmy_pipe.run()\n```\n\nDocumentation\n=============\n\nFor more details have a look at the [official documentation](https://bitbucket-pipes-toolkit.readthedocs.io).\n\n\nSupport\n=======\nIf you\u2019d like help with the toolkit, or you have an issue or feature request, let us know on [Community](https://community.atlassian.com/t5/forums/postpage/board-id/bitbucket-pipelines-questions?add-tags=pipes,toolkit).\n\nIf you\u2019re reporting an issue, please include:\n\n* the version of the toolkit\n* relevant logs and error messages\n* steps to reproduce\n",
"bugtrack_url": null,
"license": "Copyright @ 2019 Atlassian Pty Ltd Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ",
"summary": "This package contains various helpers for developing bitbucket pipelines pipes",
"version": "5.0.2",
"project_urls": {
"Changelog": "https://bitbucket.org/bitbucketpipelines/bitbucket-pipes-toolkit/src/master/CHANGELOG.md",
"Community": "https://community.atlassian.com/t5/Bitbucket/ct-p/bitbucket",
"Documentation": "https://bitbucket-pipes-toolkit.readthedocs.io",
"Homepage": "https://bitbucket.org/bitbucketpipelines/bitbucket-pipes-toolkit",
"Issues": "https://community.atlassian.com/t5/forums/postpage/board-id/bitbucket-pipelines-questions?add-tags=pipes,toolkit",
"Repository": "https://bitbucket.org/bitbucketpipelines/bitbucket-pipes-toolkit"
},
"split_keywords": [
"bitbucket",
" bitbucket pipelines",
" bitbucket pipes",
" development"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4478b44a33275810dd767e982e37b5ef9213b6c3c5e655258906fc6a47fbf5c1",
"md5": "931c62847464ed3e2448a23025fd3cd2",
"sha256": "17c00dbc4234c8cb055ab81a28886163c1bcfa760e803ee73ea994ca16759afb"
},
"downloads": -1,
"filename": "bitbucket_pipes_toolkit-5.0.2.tar.gz",
"has_sig": false,
"md5_digest": "931c62847464ed3e2448a23025fd3cd2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 15904,
"upload_time": "2024-11-01T12:11:14",
"upload_time_iso_8601": "2024-11-01T12:11:14.203668Z",
"url": "https://files.pythonhosted.org/packages/44/78/b44a33275810dd767e982e37b5ef9213b6c3c5e655258906fc6a47fbf5c1/bitbucket_pipes_toolkit-5.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-01 12:11:14",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "bitbucketpipelines",
"bitbucket_project": "bitbucket-pipes-toolkit",
"lcname": "bitbucket-pipes-toolkit"
}
JSON