A CLI with autocompletion and syntax highlighting for Docker commands.
Python Gherkin
Clone or download
Latest commit 6cb0824 Jan 1, 2018
Permalink
Failed to load latest commit information.
.github Added PR template. Dec 31, 2017
screenshots Added pycharm logo. Nov 22, 2016
scripts Added tests for info and version. Jul 11, 2016
tests Merge pull request #156 from yoshiya-hirase/update_for_2_x_x_docker_py Sep 2, 2017
wharfee Merge pull request #156 from yoshiya-hirase/update_for_2_x_x_docker_py Sep 2, 2017
.gitignore Gitignore change. Dec 20, 2015
.travis.yml Also remove python 3.3. Dec 31, 2017
LICENSE.txt Update LICENSE.txt Nov 3, 2016
README.md Added pycharm logo. Nov 22, 2016
appveyor.yml Also remove python 3.3. Dec 31, 2017
changelog.rst Releasing v0.10. Oct 21, 2016
release.py Fixed copy-paste in release script. Jul 15, 2016
requirements-dev.txt
requirements-win.txt
run_code_checks.sh Linting. Jul 18, 2015
setup.cfg
setup.py Update setup.py Nov 3, 2016
tox.ini

README.md

Stories in Ready PyPI version Join the chat at https://gitter.im/j-bennet/wharfee

wharfee

A shell for Docker that can do autocompletion and syntax highlighting.

ps

Why?

Docker commands have tons of options. They are hard to remember.

ps

Container names are hard to remember and type.

rm

Same goes for image names.

rmi

There are some handy shortcuts too. What was that command to remove all dangling images? OMG, what was it? docker rmi $(docker ps --all --quiet)? Oh, there you go:

rmi-dangling

Boom! How about removing all stopped containers?

rm-stopped

Installation

Wharfee is a Python package hosted on pypi and installed with:

$ pip install wharfee

Alternatively, you can install the latest from github and get all the bugfixes that didn't make it into pypi release yet:

$ pip install git+https://github.com/j-bennet/wharfee.git

Running

Wharfee is a console application. You run it from terminal by typing the program name into the command line:

$ wharfee

If you're on Windows, you may be not so familiar with using the terminal. But if you installed Docker (Docker Toolbox), you'll have Docker Quickstart Terminal as part of you installation. So, just as above, you'll run Docker Quickstart Terminal and type wharfee into your command prompt. After you hit Enter, you'll see wharfee prompt:

wharfee>

What are you using?

Can I contribute?

Yes! Pull request or issues are welcome.

How do you test it?

First, install the requirements for testing:

$ pip install -r requirements-dev.txt

There are unit tests under tests. The command to run them is:

$ py.test

Additionally, there are integration tests, that can be run with:

$ cd tests
$ behave

To see stdout/stderr, use the following command:

$ behave --no-capture

To enter debugger on error, use the following command:

$ behave -D DEBUG_ON_ERROR

Thanks

I develop with PyCharm