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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for bitbucket-pipes-toolkit-0.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7f15fa792883aa16a5ea2ba2eea72b6ebc79ca96446c24ba513c09e783598153 |
|
MD5 | f8ed8dda7b8924e7c287eada89754167 |
|
BLAKE2b-256 | d16a8e33d289e618dabb4b2975f442fc17c5859cd982677cd92c7bacadc98583 |