law 0.0.4

High-level extension layer for Luigi analysis workflows.

|law|
-----

|Build Status| |Documentation Status| |Package Status|

High-level extension layer for
`Luigi <https://github.com/spotify/luigi>`__ analysis workflows.

.. rubric:: This project is currently under development.
:name: this-project-is-currently-under-development.

Installation and dependencies
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Install via `pip <https://pypi.python.org/pypi/tfdeploy>`__:

.. code:: bash

pip install law

This should also install `luigi <https://pypi.python.org/pypi/luigi>`__
and `six <https://pypi.python.org/pypi/six>`__.

Content
~~~~~~~

- `TODO <#todo>`__
- `Development <#development>`__
- `Authors <#authors>`__
- `License <#license>`__

TODO
----

Config
''''''

- ``core``:

- ``db_file``: The path to the db file. Defaults to
``$HOME/.law/db``
- ``target_tmp_dir``: The directory where tmp targets are stored.
Defaults to ``tempfile.gettempdir()``.

- ``target``:

- ``gfal2_log_level``: The log level of the gfal2 handler, a string
describing a python log level. Defaults to ``"INFO"``.
- ``default_dropbox``: The section of the dropbox config to use by
default. Defaults to ``"dropbox"``.
- ``default_dcache``: The section of the dcache config to use by
default. Defaults to ``"dcache"``.

- ``paths``: Listing of paths to look for tasks when creating the db
file.

Example remote target configs


::

[target]

default_dropbox: my_dropbox
default_dcache: my_dcache


[my_dropbox]

base: ...
app_key: ...
app_secret: ...
access_token: ...


[my_dache]

base: ...
base_listdir: ... (optional)

Environment variables
'''''''''''''''''''''

- ``LAW_CONFIG_FILE``
- ``LAW_DB_FILE``
- ``LAW_SANDBOX``
- ``LAW_SANDBOX_SWITCHED``
- ``LAW_SANDBOX_WORKER_ID``
- ``LAW_DROPBOX_CONFIG_FILE``

Enable bash completion
''''''''''''''''''''''

.. code:: bash

source `law_completion`

Development
-----------

- Source hosted at `GitHub <https://github.com/riga/law>`__
- Report issues, questions, feature requests on `GitHub
Issues <https://github.com/riga/law/issues>`__

Developing with Docker
^^^^^^^^^^^^^^^^^^^^^^

*Note*: Due to a change to the base image ``cern/cc7-base`` the current
docker images do not compile. This will be fixed soon.

.. code:: bash

docker run -ti -p 8082:8082 riga/law
git pull && law db

# or when passing a local checkout as a volume

docker run -ti -p 8082:8082 -v /path/to/law:/root/law riga/law

# the config can be passed as well by adding (e.g.)
-v $HOME/.law/config:/root/.law/config

For particular tags, see `riga/law on
DockerHub <https://hub.docker.com/r/riga/law/>`__.

Developing without Docker
^^^^^^^^^^^^^^^^^^^^^^^^^

.. code:: bash

source dev.sh
law db

Authors
-------

- `Marcel R. <https://github.com/riga>`__

License
-------

The MIT License (MIT)

Copyright (c) 2016-2017 Marcel R.

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

.. |law| image:: https://raw.githubusercontent.com/riga/law/master/logo.png
:target: https://github.com/riga/law
.. |Build Status| image:: https://travis-ci.org/riga/law.svg?branch=master
:target: https://travis-ci.org/riga/law
.. |Documentation Status| image:: https://readthedocs.org/projects/law/badge/?version=latest
:target: http://law.readthedocs.io/en/latest/?badge=latest
.. |Package Status| image:: https://img.shields.io/pypi/v/law.svg
:target: https://pypi.python.org/pypi/law