README.rst 2.19 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
===============================
OpenBuildingMap Data API Server
===============================


|Build status|
 .. |Build status| image:: https://git.gfz-potsdam.de/dynamicexposure/openbuildingmap/data-api-server/badges/master/pipeline.svg
  :target: https://git.gfz-potsdam.de/dynamicexposure/openbuildingmap/data-api-server/-/commits/master

Idea
----

Provide an API for data access around the OpenBuildingMap.

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

    * python >= 3.7
19
    * quart >= 0.15.1
20
21
22
23
24
25
26
27
28
29
30
31
32
33

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

    pip3 install .

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

Development and linting dependencies can be installed with:

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

Felix Delattre's avatar
Felix Delattre committed
34
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 `pre-commit <https://pre-commit.com/>`_.
35
36

    pre-commit install
37
38
39
40
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
68

Copyright and copyleft
----------------------

Copyright (C) 2021

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