Getting started with the CaosDB Crawler

Installation

see INSTALL.md

Run Unit Tests

Run pytest unittests.

Documentation

We use sphinx to create the documentation. Docstrings in the code should comply with the Googly style (see link below).

Build documentation in src/doc with make html.

Requirements

  • sphinx

  • sphinx-autoapi

  • recommonmark

  • sphinx-rtd-theme