Metadata-Version: 2.4
Name: dockerctl
Version: 1.1
Summary: Python Script to steer (multiple) docker-compose-yaml's from everywhere.
Home-page: https://github.com/bionade24/dockerctl
Author: Oskar Roesler (bionade24)
Author-email: o.roesler@oscloud.info
License: GPLv3
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: POSIX :: Linux
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: argparse
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

# dockerctl

Python Script to steer docker-compose-yaml's from everywhere.

https://pypi.org/project/dockerctl/

Installation:
==

Installation from PyPi: `pip install dockerctl`  
Manual installation: Type `pip install .` in the project's directory  
  
*Be aware that you have to call python3 pip, so if you're on an distro that defaults to py2, use* `python3 -m pip`

This program is released under the GPLv3. See "LICENSE" for further information.

This program is going to have the first release soon, please report bugs and propose enhancements.

```
usage: dockerctl [-h] [-v] [-l] [--list] [--path PATH] COMMAND COMPOSE_NAME [extra ARGS passed to docker-compose]
                 start: Start the composition
                 stop: Stop the composition
                 restart: Restart it.
                 ps: Show processes of services in composition.
                 up: Calls docker-compose up -d, composition runs as daemon afterwards.
                 down: Calls docker-compose down, composition gets stopped and deleted.
                 kill: Kill the whole composition, if you don't pass extra args.
                 rm: Removes all volumes created by the compose yaml.
                 top: Get information about the processes in the services.
                 logs: Get the logs of the whole composition. Pass -f to get ongoing information.
                 images: Shows images used by the services in the composition.
                 port: Shows the port used and mapped by the composition.
                 pull: Pull images needed by the composition.
                 push: Push built images of the composition.
                 pause: Pause all services in the composition.
                 unpause: Unpause them.
                 add: Links the current dir to a folder with the compose_name under /etc/docker. Use [--path] to link an other path than curdir.
                 remove: Removes composition folder or link under /etc/docker
                 exec: Exec something in a service of a container. [ARGS] can optionally be used to write the command.
                 edit: Edit the docker-compose.yml. Uses the EDITOR env var.
                 show: Shows the docker-compose.yml in less.
                 create: Create dir with compos_name under /etc/docker
                 update: Runs pull and up in one command to update a composition.
```
