Metadata-Version: 2.0
Name: containerutil
Version: 0.1.0
Summary: Tools for inspecting contents of docker container filesystem.
Home-page: https://github.com/pavdmyt/containerutil
Author: Pavlo Dmytrenko
Author-email: mail@pavdmyt.com
License: MIT
Download-URL: https://github.com/pavdmyt/containerutil/archive/master.zip
Description-Content-Type: UNKNOWN
Keywords: docker container path pathlib file type filesystem
Platform: any
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
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 :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System
Classifier: Topic :: System :: Filesystems
Classifier: Topic :: Utilities

containerutil
=============

``containerutil.Path`` provides API similar to `pathlib.Path`_ for inspecting
`docker container`_ file system:

.. code:: python

    import docker
    import containerutil

    client = docker.from_env(version='auto')
    ctnr = client.containers.get('my-container')

    p = containerutil.Path(ctnr, '/foo/bar/path')

    p.exists()        # True if file exists (regardless of type)
    p.is_file()       # True if file exists and is a regular file
    p.is_symlink()    # True if file exists and is a symbolic link
    p.is_fifo()       # True if file is a named pipe (FIFO)


Installation
------------

From `PyPI`_ using ``pip`` package manager:

.. code:: bash

    pip install --upgrade containerutil


Or install the latest sources from GitHub:

.. code:: bash

    pip install https://github.com/pavdmyt/containerutil/archive/master.zip


License
-------

MIT - Pavlo Dmytrenko


.. _pathlib.Path: https://docs.python.org/3/library/pathlib.html
.. _docker container: https://www.docker.com/what-container
.. _PyPI: https://pypi.org/


