Opinionated wrapper around docker
Project description
An opinionated wrapper around the docker-py API to docker that knows how to read yaml files and make things happen.
See http://harpoon.readthedocs.org for the full documentation.
Installation
Just use pip:
pip install docker-harpoon
Usage
Once harpoon is installed, there will be a new program called harpoon.
When you call harpoon without any arguments it will print out the tasks you have available.
Unless you don’t have a config file, in which case it’ll complain you have no configuration file.
The configuration file will default to ./harpoon.yml unless you specify a different value via the HARPOON_CONFIG environment variable or the --harpoon-config cli argument.
Once you have a valid configuration file and have chosen a task you wish to invoke, you may use the --task cli option to invoke that task.
Simpler Usage
To save typing --task and --image too much, the first positional argument is treated as task (unless it is prefixed with a -) and the second positional argument (if also not prefixed with a -) is taken as the image.
So:
$ harpoon --task run --image my_amazing_image
Is equivalent to:
$ harpoon run my_amazing_image
Logging colors
If you find the logging output doesn’t look great on your terminal, you can try setting the term_colors option in harpoon.yml to either light or dark.
Tests
Install testing deps and run the helpful script:
pip install -e . pip install -e ".[tests]" ./test.sh
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.