tuulbachs documentation

Low-level software tuuls, organized into drawers.

tuulbash

kickpy - A bash script intended to kick a Python script from an environment that doesn’t have an estabished Python environment yet. For example:

./kickpy.sh example.py

tuulcli

Tuuls for command line interface (CLI).

tuuldevops

Automation tuuls for common tasks around software development

tuulgit

An opinionated set of Git tuuls.

tuulpy

subpResult.py - Run a command from Python and return the result. Example::

python subpResult.py

tuulver

Parsing tuuls for a tuulbachs-formatted version YAML input file.

tuulyaml

Low level tuuls for interacting with YAML files.

install

Note that tuulbachs is not yet published at PyPi.

  1. Set up and activate a Python virtual environment at the top level of this project

  2. pip install -r requirements.txt

  3. cd to the local auto directory

  4. ./install_local.sh

deploy

Guidance about how to deploy updates to tuulbachs itself

  1. Decide which type of semantic version upgrade this is (major, minor, patch, etc.)

  2. From tuulver/version.py, use the appropriate bump_* function to update the version string in version.yaml

  3. Follow install guidance

  4. Commit changes to Git

  5. From tuuldevops/tag_current_version.py, use the tag_product_version function to properly tag this release

  6. Push the Git update (including tags) to this repo’s remotes

internal API

This is code intended for use by tuulbachs itself, not external users.

Indices and tables