Metadata-Version: 1.1
Name: dockeb
Version: 0.3.0
Summary: The Keb Docker wrapper
Home-page: https://github.com/abusque/dockeb
Author: Antoine Busque
Author-email: antoinebusque@gmail.com
License: MIT
Description: ======
        dockeb
        ======
        
        .. image:: https://img.shields.io/pypi/v/dockeb.svg
           :target: https://pypi.org/project/dockeb/
           :alt: PyPI
        
        *Documentation aussi disponible en* `français <README.fr.rst>`_
        
        **dockeb**, the Keb Docker wrapper.
        
        **dockeb** can be used as a drop-in replacement for the
        `Docker command-line <https://docs.docker.com/engine/reference/commandline/cli/>`_.
        
        The difference between docker and **dockeb** is name generation. While
        docker generates names of the form ``adjective_surname`` for
        containers, **dockeb** generates a random Keb name.
        
        If you give an explicit name to a container, using the ``--name``
        flag, it will be left unchanged.
        
        Requirements
        ------------
        
        To run **dockeb**, you will need Python ≥ 3.4, as well as `Docker
        <https://docs.docker.com/>`_.
        
        For installing, we recommend using the ``pip`` package manager.
        
        Installing
        ----------
        
        To install **dockeb** system-wide, run:
        
        .. code-block:: sh
        
           sudo pip3 install dockeb
        
        To install **dockeb** manually from source, the steps are as follows:
        
        .. code-block:: sh
        
           git clone git@github.com:abusque/dockeb.git
           cd dockeb
           sudo ./setup.py install
        
        Using
        -----
        
        Once installed, you can use **dockeb** by running the following command:
        
        .. code-block:: sh
        
           dockeb
        
        For a more interesting command, try:
        
        .. code-block:: sh
        
           dockeb run hello-world
           dockeb ps -a
        
        You will notice that the container was given a Keb name when created.
        
        To automatically use **dockeb** instead of ``docker``, consider
        defining an alias in your shell configuration:
        
        .. code-block:: sh
        
           alias docker='dockeb'
        
        Development
        -----------
        
        For local development of **dockeb**, you may use
        `pipenv <https://docs.pipenv.org/>`_. Use ``pipenv install --dev`` to
        generate a virtual environment into which the dependencies will be
        installed. You may then use ``pipenv shell`` to activate that
        environment.
        
        For publishing releases to PyPI, we recommend using
        `Twine <https://pypi.org/project/twine/>`_.
        
        See Also
        --------
        
        * `qng <https://github.com/abusque/qng>`_, the Queb name generator.
        
Keywords: docker,wrapper,quebec
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 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
