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-6.2.0.tar.gz (13.5 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: bitbucket_pipes_toolkit-6.2.0.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for bitbucket_pipes_toolkit-6.2.0.tar.gz
Algorithm Hash digest
SHA256 a942c15b6385f080e60de65c59a42267965c9c53277509659d58b5448f0de6c2
MD5 91e1e286b0998def7b1b3c30cf9c5719
BLAKE2b-256 4bc55cb59e5e00c9e1cf46b787f6ff5cd55360a417572f4879b9548331fd1101

See more details on using hashes here.

Supported by

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