Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

This package containes various helpers for developing bitbucket pipelines pipes

Project description

Pipetools
=========
This package contains various tools and helpers to make it more fun and easy for people to develope pipes.

Installation
============

`pip install bitbucket_pipes_toolkit`

Module pipetools.helpers
========================

Functions
---------

`configure_logger()`
: Configure logger to produce colorized output.

`enable_debug()`
: Enable the debug log level.

`fail(message='Fail!', do_exit=True)`
: Prints the colorized failure message (in red)

Args:
message (str, optional): Output message
do_exit (bool, optional): Call sys.exit if set to True

`get_variable(name, required=False, default=None)`
: Fetch the value of a pipe variable.

Args:
name (str): Variable name.
required (bool, optional): Throw an exception if the env var is unset.
default (:obj:`str`, optional): Default value if the env var is unset.

Returns:
Value of the variable

Raises
Exception: If a required variable is missing.

`required(name)`
: Get the value of a required pipe variable.

This function is basically an alias to get_variable with the required
parameter set to True.

Args:
name (str): Variable name.

Returns:
Value of the variable

Raises
Exception: If a required variable is missing.

`success(message='Success', do_exit=True)`
: Prints the colorized success message (in green)

Args:
message (str, optional): Output message
do_exit (bool, optional): Call sys.exit if set to True

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
bitbucket-pipes-toolkit-0.5.0.tar.gz (3.4 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page