Introduction

A library of various tools for common python tasks

See documentation for details.

Installation for Developers

Docker

1. Install docker-desktop
2. Ensure docker-desktop has at least 4 GB of memory allocated to it.
3. git clone git@github.com:theNewFlesh/lunchbox.git
4. cd lunchbox
5. chmod +x bin/lunchbox
6. bin/lunchbox docker-start
   • If building on a silicon Mac change the value of the PLATFORM variable in the cli.py module to linux/arm64.

The service should take a few minutes to start up.

Run bin/lunchbox --help for more help on the command line tool.

ZSH Setup

1. bin/lunchbox must be run from this repository's top level directory.

2. Therefore, if using zsh, it is recommended that you paste the following line in your ~/.zshrc file:

   • alias lunchbox="cd [parent dir]/lunchbox; bin/lunchbox"
   • Replace [parent dir] with the parent directory of this repository

3. Consider adding the following line to your ~/.zshrc if you are using a silicon Mac:

   • export DOCKER_DEFAULT_PLATFORM=linux/arm64

4. Running the zsh-complete command will enable tab completions of the cli commands, in the next shell session.

   For example:

   • lunchbox [tab] will show you all the cli options, which you can press tab to cycle through
   • lunchbox docker-[tab] will show you only the cli options that begin with "docker-"

Installation for Production

Python

pip install lunchbox

Please see the prod.dockerfile for an official example of how to build a docker image with lunchbox.

Docker

1. Install docker-desktop
2. docker pull theNewFlesh/lunchbox:[mode]-[version]

Quickstart Guide

This repository contains a suite commands for the whole development process. This includes everything from testing, to documentation generation and publishing pip packages.

These commands can be accessed through:

• The VSCode task runner
• The VSCode task runner side bar
• A terminal running on the host OS
• A terminal within this repositories docker container

Running the zsh-complete command will enable tab completions of the CLI. See the zsh setup section for more information.

Command Groups

Development commands are grouped by one of 10 prefixes:

Common Commands

Here are some frequently used commands to get you started:

Development CLI

bin/lunchbox is a command line interface (defined in cli.py) that works with any version of python 2.7 and above, as it has no dependencies. Commands generally do not expect any arguments or flags.

Its usage pattern is: bin/lunchbox COMMAND [-a --args]=ARGS [-h --help] [--dryrun]

Commands

The following is a complete list of all available development commands:

Flags

Production CLI

lunchbox comes with a command line interface defined in command.py.

Its usage pattern is: lunchbox COMMAND [ARGS] [FLAGS] [-h --help]

Commands

bash-completion

Prints BASH completion code to be written to a _lunchbox completion file

Usage: lunchbox bash-completion

slack

Posts a slack message to a given channel

Usage: lunchbox slack URL CHANNEL MESSAGE

zsh-completion

Prints ZSH completion code to be written to a _lunchbox completion file

Usage: lunchbox zsh-completion