Labelbox Utils
==============

.. image:: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/LabelboxUtils/raw/master/project-icon.png
   :height: 128px
   :width: 128px
   :target: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/LabelboxUtils
   :alt: Logo

.. image:: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/LabelboxUtils/badges/master/build.svg
   :target: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/LabelboxUtils/pipelines
   :alt: GitLab-CI test status

.. image:: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/LabelboxUtils/badges/master/coverage.svg
    :target: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/LabelboxUtils/commits/master
    :alt: Test coverage

.. image:: https://readthedocs.org/projects/LabelboxUtils/badge/?version=latest
    :target: http://LabelboxUtils.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status


Author: Matt Clarkson

LabelboxUtils contains python scripts for working with Labelbox. Features so
far include:

* ```labelbox_export_json```: Takes .json file and extracts masks.

For command line apps, run with ```-h``` to see more usage information.


Developing
----------

Cloning
^^^^^^^

You can clone the repository using the following command:

::

    git clone https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/LabelboxUtils


Running tests
^^^^^^^^^^^^^

Pytest is used for running unit tests, but you should run using tox,
as per the `PythonTemplate`_ instructions.


Linting
^^^^^^^

This code conforms to the PEP8 standard. Pylint is used to analyse the code.
Again, follow the `PythonTemplate`_ instructions and run via tox.


Installing
----------

You can pip install directly from the repository as follows:

::

    pip install git+https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/LabelboxUtils


Contributing
------------

Please see the `contributing guidelines`_.


Useful links
------------

* `Source code repository`_
* `Documentation`_


Licensing and copyright
-----------------------

Copyright 2019 `University College London (UCL)`_.
Labelbox Utils is released under the Apache Software License 2.0. Please see the `license file`_ for details.


Acknowledgements
----------------

Supported by `Wellcome`_ and `EPSRC`_.


.. _`source code repository`: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/LabelboxUtils
.. _`Documentation`: https://LabelboxUtils.readthedocs.io
.. _`University College London (UCL)`: http://www.ucl.ac.uk/
.. _`Wellcome`: https://wellcome.ac.uk/
.. _`EPSRC`: https://www.epsrc.ac.uk/
.. _`contributing guidelines`: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/LabelboxUtils/blob/master/CONTRIBUTING.rst
.. _`license file`: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/LabelboxUtils/blob/master/LICENSE
.. _`PythonTemplate`: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/PythonTemplate