Bitbucket Pipes Toolkit
=========
![Coverage](https://bitbucket.org/bitbucketpipelines/bitbucket-pipes-toolkit/downloads/coverage.svg)
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).
Raw data
{
"_id": null,
"home_page": "https://bitbucket.org/bitbucketpipelines/bitbucket-pipes-toolkit",
"name": "bitbucket-pipes-toolkit",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Atlassian",
"author_email": "bitbucketci-team@atlassian.com",
"download_url": "https://files.pythonhosted.org/packages/1f/04/db531290ff8bfd868de2b793af5fefc2017d66156787bf676db7b3b4b04a/bitbucket-pipes-toolkit-4.2.1.tar.gz",
"platform": null,
"description": "Bitbucket Pipes Toolkit\n=========\n\n![Coverage](https://bitbucket.org/bitbucketpipelines/bitbucket-pipes-toolkit/downloads/coverage.svg)\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",
"bugtrack_url": null,
"license": "",
"summary": "This package contains various helpers for developing bitbucket pipelines pipes",
"version": "4.2.1",
"project_urls": {
"Homepage": "https://bitbucket.org/bitbucketpipelines/bitbucket-pipes-toolkit"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1f04db531290ff8bfd868de2b793af5fefc2017d66156787bf676db7b3b4b04a",
"md5": "7910404df2ecad435312b6ec8dbc915e",
"sha256": "012a4638378d35639501deb34e41e02ed6f8c23c4a25ff83d1b557a2543ea293"
},
"downloads": -1,
"filename": "bitbucket-pipes-toolkit-4.2.1.tar.gz",
"has_sig": false,
"md5_digest": "7910404df2ecad435312b6ec8dbc915e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10259,
"upload_time": "2023-10-06T09:08:30",
"upload_time_iso_8601": "2023-10-06T09:08:30.973192Z",
"url": "https://files.pythonhosted.org/packages/1f/04/db531290ff8bfd868de2b793af5fefc2017d66156787bf676db7b3b4b04a/bitbucket-pipes-toolkit-4.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-06 09:08:30",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "bitbucketpipelines",
"bitbucket_project": "bitbucket-pipes-toolkit",
"lcname": "bitbucket-pipes-toolkit"
}