README.rst 2.86 KB
Newer Older
Matt Clarkson's avatar
Matt Clarkson committed
1
Labelbox Utils
2
==============
Matt Clarkson's avatar
Matt Clarkson committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

.. 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

25 26
LabelboxUtils contains python scripts for working with Labelbox. Features so
far include:
Matt Clarkson's avatar
Matt Clarkson committed
27

28
* ```labelbox_export_json```: Takes .json file and extracts masks.
Matt Clarkson's avatar
Matt Clarkson committed
29

30
For command line apps, run with ```-h``` to see more usage information.
Matt Clarkson's avatar
Matt Clarkson committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48


Developing
----------

Cloning
^^^^^^^

You can clone the repository using the following command:

::

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


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

49 50
Pytest is used for running unit tests, but you should run using tox,
as per the `PythonTemplate`_ instructions.
Matt Clarkson's avatar
Matt Clarkson committed
51 52 53 54 55


Linting
^^^^^^^

56 57
This code conforms to the PEP8 standard. Pylint is used to analyse the code.
Again, follow the `PythonTemplate`_ instructions and run via tox.
Matt Clarkson's avatar
Matt Clarkson committed
58 59 60 61 62 63 64 65 66 67 68 69 70


Installing
----------

You can pip install directly from the repository as follows:

::

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


Contributing
71
------------
Matt Clarkson's avatar
Matt Clarkson committed
72 73 74 75 76

Please see the `contributing guidelines`_.


Useful links
77
------------
Matt Clarkson's avatar
Matt Clarkson committed
78 79 80 81 82 83 84 85

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


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

86
Copyright 2019 `University College London (UCL)`_.
Matt Clarkson's avatar
Matt Clarkson committed
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
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
103
.. _`PythonTemplate`: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/PythonTemplate