Skip to main content

Commandline interface for using docker reproducibly

Project description

dockre
======

.. image:: http://hera.physchem.kth.se:9090/api/badges/bjodah/dockre/status.svg
:target: http://hera.physchem.kth.se:9090/bjodah/dockre
:alt: Build status
.. image:: https://img.shields.io/pypi/v/dockre.svg
:target: https://pypi.python.org/pypi/dockre
:alt: PyPI version
.. image:: https://img.shields.io/pypi/l/dockre.svg
:target: https://github.com/bjodah/dockre/blob/master/LICENSE
:alt: License


`dockre <https://github.com/bjodah/dockre>`_ provides a
command line interface (through a `Python <http://www.python.org>`_ packge) for using **dock**er **re**producibly to build
e.g. documents, binaries or host services. The default docker image used is the authors
personal one for work related tasks but it is changeable by specifying ``--image``.


Documentation
-------------
Autogenerated API documentation is found `here <http://hera.physchem.kth.se/~dockre/branches/master/html>`_.

Installation
------------
Simplest way to install ``dockre`` is to use ``pip``:

::

$ pip install --user dockre


Examples
--------
Here is a simple example:

.. code:: bash

$ mkdir input
$ echo -e "report.txt:\n\techo 'silly example'>\$@" > input/Makefile
$ mkdir output
$ dockre build
$ cat output/report.txt
silly example


License
-------
The source code is Open Source and is released under the simplified 2-clause BSD license. See `LICENSE <LICENSE>`_ for further details.

Contributors are welcome to suggest improvements at https://github.com/bjodah/dockre

Author
------
Björn I. Dahlgren, contact:

- gmail address: bjodah
- kth.se address: bda

Project details


Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page