Skip to main content

This package contains various helpers for developing bitbucket pipelines pipes

Project description

Bitbucket Pipes Toolkit

Coverage

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

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.

Support

If you’d like help with the toolkit, or you have an issue or feature request, let us know on Community.

If you’re reporting an issue, please include:

the version of the toolkit relevant logs and error messages steps to reproduce

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bitbucket_pipes_toolkit-5.0.1.tar.gz (15.9 kB view details)

Uploaded Source

File details

Details for the file bitbucket_pipes_toolkit-5.0.1.tar.gz.

File metadata

File hashes

Hashes for bitbucket_pipes_toolkit-5.0.1.tar.gz
Algorithm Hash digest
SHA256 b6e9f9c16bfd4a377085eef7fb3a224dd3bb304bf583f73e2b68d3041f273e2b
MD5 32e83fbfdc8e485be1ead2c4fb671a43
BLAKE2b-256 4b4afc783fcdda99f854d0e14f0276f4e6db580b06603ca6f14219e2447bb432

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page