Metadata-Version: 2.1
Name: docker-clean
Version: 1.0.2
Summary: A command to clean docker images, containers, networks and volumes.
Home-page: http://github.com/stakkr-org/docker-clean
Author: Emmanuel Dyan
Author-email: emmanueldyan@gmail.com
License: Apache 2.0
Keywords: docker,python
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development
Classifier: Topic :: System :: Distributed Computing
Classifier: Topic :: System :: Systems Administration
License-File: LICENSE
Requires-Dist: click>=7
Requires-Dist: clint==0.5.1
Requires-Dist: docker>3.7
Requires-Dist: humanfriendly==4.18

Overview
========

.. image:: https://scrutinizer-ci.com/g/stakkr-org/docker-clean/badges/quality-score.png?b=master
   :target: https://scrutinizer-ci.com/g/stakkr-org/docker-clean
.. image:: https://travis-ci.com/stakkr-org/docker-clean.svg?branch=master
   :target: https://travis-ci.com/stakkr-org/docker-clean
.. image:: https://img.shields.io/pypi/l/docker-clean.svg
   :target: https://pypi.python.org/pypi/docker-clean
.. image:: https://api.codeclimate.com/v1/badges/0d084cbb66933be59317/maintainability
   :target: https://codeclimate.com/github/stakkr-org/docker-clean/maintainability
   :alt: Maintainability
.. image:: https://api.codeclimate.com/v1/badges/0d084cbb66933be59317/test_coverage
   :target: https://codeclimate.com/github/stakkr-org/docker-clean/test_coverage
   :alt: Test Coverage


Docker-Clean
============

Command line tool to clean docker containers, images, volumes and networks
that are not in use currently (started).


.. code:: bash

    Usage: docker-clean [OPTIONS]

      Clean Docker containers, images, volumes and networks that are not in use

    Options:
      -f, --force                           Do it
      -c, --containers / --no-containers    Remove containers
      -i, --images / --no-images            Remove images
      -V, --volumes / --no-volumes          Remove volumes
      -n, --networks / --no-networks        Remove networks
      --help                                Show this message and exit.



Development
===========

Setup your env
--------------

To develop, you have to create a virtual environment :

.. code:: bash

    $ git clone git@github.com:stakkr-org/docker-clean.git docker-clean
    $ cd docker-clean
    $ python3 -m venv venv
    $ source venv/bin/activate
    # For Windows use "venv\Scripts\activate"


Then install docker-clean and its dependencies :

.. code:: bash

    $ python -m pip install --upgrade pip
    $ python -m pip install -e .
    $ python -m pip install -r requirements-dev.txt


Run Tests
---------

.. code:: bash

    $ py.test
