README.rst 2.09 KB
Newer Older
1
2
3
========
rabotnik
========
4

5
6
7
8
|Build status|
 .. |Build status| image:: https://git.gfz-potsdam.de/dynamicexposure/rabotnik/rabotnik/badges/master/pipeline.svg
  :target: https://git.gfz-potsdam.de/dynamicexposure/rabotnik/rabotnik/-/commits/master

9
10
11
12
13
14
15
16
17
18
19
20
21
22
Idea
----

Processing engine based on `Celery <http://celeryproject.org/>`__.

Requirements
------------

    * python >= 3.6
    * Celery >= 5.0

Installation
------------

23
    pip3 install .
24

25
26
27
28
29
30
31
32
33
34
35
36
Contributing
------------

Development and linting dependencies can be installed with:

    pip3 install .[tests]
    pip3 install .[linters]

We use `black` and `flake8` for consistent code style and `pylint` for general linting. Project linting comes pre-defined in `.pre-commit` to be used in `https://pre-commit.com/`_.

    pre-commit install

37
38
39
Copyright and copyleft
----------------------

40
Copyright (c) 2020-2021
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

* Helmholtz-Zentrum Potsdam Deutsches GeoForschungsZentrum GFZ

This program is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see http://www.gnu.org/licenses/.

Also add information on how to contact you by electronic and paper mail.

If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.

See the `LICENSE <./LICENSE>`__ for the full license text.