doc(README): add citation suggestion

bump version to 0.3.0 closes #122 --------- Co-authored-by: christina <[email protected]>
GIScience · Dec 6, 2023 · 289f4c5 · 289f4c5
1 parent d2ee0a2
commit 289f4c5
Show file tree

Hide file tree

Showing 42 changed files with 123 additions and 99 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,7 @@
 # Changelog
 
+## 0.3.0
+
 ### Added
 
  - support for python 3.12

diff --git a/README.md b/README.md
@@ -128,6 +128,28 @@ time = ['2018-01-01', '2018-02-01', '2018-03-01']
 time = datetime.datetime(year=2018, month=3, day=1)
 time = pandas.date_range("2018-01-01", periods=3, freq="M")
 ```
+## Citation
+
+When using [ohsome-py](https://github.com/GIScience/ohsome-py) e.g. for a publication or elsewhere, please cite the ohsome-api as described in their [citation recommendation](https://github.com/GIScience/ohsome-api/blob/master/README.md#how-to-cite) for example like
+
+> M. Raifer, R. Troilo, F.-B. Mocnikand M. Schott, ‘OSHDB - OpenStreetMap History Data Analysis version 1.2.1 accessed via the ohsome-py library version 0.3.0’. Zenodo, Sep. 29, 2023. doi: 10.5281/zenodo.8391737.
+
+
+```bibtex
+@software{raifer_2023_7713347,
+  author       = {Raifer, Martin and
+                  Troilo, Rafael and
+                  Mocnik, Franz-Benjamin and
+                  Schott, Moritz},
+  title        = {OSHDB - OpenStreetMap History Data Analysis version 1.2.1 accessed via the ohsome-py library version 0.3.0},
+  month        = sep,
+  year         = 2023,
+  publisher    = {Zenodo},
+  version      = {1.2.1},
+  doi          = {10.5281/zenodo.8391737},
+  url          = {https://doi.org/10.5281/zenodo.8391737}
+}
+```
 
 ## Contribution Guidelines
 
@@ -143,7 +165,7 @@ This package uses [poetry](https://python-poetry.org/) for dependency management
 
 **Install the pre-commit hooks** in our local git repo before committing to ensure homogenous code style.
 
-`poertry run pre-commit install`
+`poetry run pre-commit install`
 
 ### Run Tests
 

diff --git a/ohsome/constants.py b/ohsome/constants.py
@@ -7,4 +7,4 @@
 DEFAULT_LOG = True
 DEFAULT_LOG_DIR = Path("./ohsome_log")
 # update version in pyproject.toml as well
-OHSOME_VERSION = "0.2.0"
+OHSOME_VERSION = "0.3.0"
diff --git a/ohsome/test/cassettes/test_client/test_check_time_parameter_datetime.yaml b/ohsome/test/cassettes/test_client/test_check_time_parameter_datetime.yaml
@@ -13,7 +13,7 @@ interactions:
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: POST
     uri: https://api.ohsome.org/v1/elements/count
   response:
@@ -43,7 +43,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 29 Nov 2023 14:33:51 GMT
+      - Wed, 06 Dec 2023 08:19:12 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_check_time_parameter_list.yaml b/ohsome/test/cassettes/test_client/test_check_time_parameter_list.yaml
@@ -13,7 +13,7 @@ interactions:
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: POST
     uri: https://api.ohsome.org/v1/elements/count
   response:
@@ -44,7 +44,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 29 Nov 2023 14:33:51 GMT
+      - Wed, 06 Dec 2023 08:19:10 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_end_timestamp_as_time_input.yaml b/ohsome/test/cassettes/test_client/test_end_timestamp_as_time_input.yaml
@@ -13,7 +13,7 @@ interactions:
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: POST
     uri: https://api.ohsome.org/v1/elements/count
   response:
@@ -42,7 +42,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 29 Nov 2023 14:33:53 GMT
+      - Wed, 06 Dec 2023 08:19:12 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_format_bboxes_dataframe.yaml b/ohsome/test/cassettes/test_client/test_format_bboxes_dataframe.yaml
@@ -13,7 +13,7 @@ interactions:
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: POST
     uri: https://api.ohsome.org/v1/elements/count
   response:
@@ -42,7 +42,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 29 Nov 2023 14:33:55 GMT
+      - Wed, 06 Dec 2023 08:19:18 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_format_bboxes_list.yaml b/ohsome/test/cassettes/test_client/test_format_bboxes_list.yaml
@@ -13,7 +13,7 @@ interactions:
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: POST
     uri: https://api.ohsome.org/v1/elements/count
   response:
@@ -42,7 +42,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 29 Nov 2023 14:33:57 GMT
+      - Wed, 06 Dec 2023 08:19:19 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:
@@ -70,7 +70,7 @@ interactions:
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: POST
     uri: https://api.ohsome.org/v1/elements/count
   response:
@@ -99,7 +99,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 29 Nov 2023 14:33:57 GMT
+      - Wed, 06 Dec 2023 08:19:19 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:
@@ -127,7 +127,7 @@ interactions:
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: POST
     uri: https://api.ohsome.org/v1/elements/count
   response:
@@ -156,7 +156,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 29 Nov 2023 14:33:57 GMT
+      - Wed, 06 Dec 2023 08:19:21 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:
@@ -184,7 +184,7 @@ interactions:
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: POST
     uri: https://api.ohsome.org/v1/elements/count
   response:
@@ -213,7 +213,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 29 Nov 2023 14:33:58 GMT
+      - Wed, 06 Dec 2023 08:19:21 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:
@@ -241,7 +241,7 @@ interactions:
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: POST
     uri: https://api.ohsome.org/v1/elements/count
   response:
@@ -270,7 +270,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 29 Nov 2023 14:33:58 GMT
+      - Wed, 06 Dec 2023 08:19:22 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_format_bcircles_dataframe.yaml b/ohsome/test/cassettes/test_client/test_format_bcircles_dataframe.yaml
@@ -13,7 +13,7 @@ interactions:
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: POST
     uri: https://api.ohsome.org/v1/elements/count/groupBy/boundary
   response:
@@ -45,7 +45,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 29 Nov 2023 14:33:53 GMT
+      - Wed, 06 Dec 2023 08:19:13 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_format_bcircles_list.yaml b/ohsome/test/cassettes/test_client/test_format_bcircles_list.yaml
@@ -13,7 +13,7 @@ interactions:
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: POST
     uri: https://api.ohsome.org/v1/elements/count
   response:
@@ -42,7 +42,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 29 Nov 2023 14:33:53 GMT
+      - Wed, 06 Dec 2023 08:19:13 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:
@@ -70,7 +70,7 @@ interactions:
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: POST
     uri: https://api.ohsome.org/v1/elements/count/groupBy/boundary
   response:
@@ -102,7 +102,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 29 Nov 2023 14:33:54 GMT
+      - Wed, 06 Dec 2023 08:19:15 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:
@@ -130,7 +130,7 @@ interactions:
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: POST
     uri: https://api.ohsome.org/v1/elements/count
   response:
@@ -159,7 +159,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 29 Nov 2023 14:33:54 GMT
+      - Wed, 06 Dec 2023 08:19:15 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:
@@ -187,7 +187,7 @@ interactions:
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: POST
     uri: https://api.ohsome.org/v1/elements/count
   response:
@@ -216,7 +216,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 29 Nov 2023 14:33:54 GMT
+      - Wed, 06 Dec 2023 08:19:17 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_format_bcircles_pandas.yaml b/ohsome/test/cassettes/test_client/test_format_bcircles_pandas.yaml
@@ -13,7 +13,7 @@ interactions:
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: POST
     uri: https://api.ohsome.org/v1/elements/count/groupBy/boundary
   response:
@@ -51,7 +51,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 29 Nov 2023 14:33:55 GMT
+      - Wed, 06 Dec 2023 08:19:17 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_format_bpolys.yaml b/ohsome/test/cassettes/test_client/test_format_bpolys.yaml
@@ -13,7 +13,7 @@ interactions:
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: POST
     uri: https://api.ohsome.org/v1/elements/count
   response:
@@ -42,7 +42,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 29 Nov 2023 14:33:55 GMT
+      - Wed, 06 Dec 2023 08:19:18 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_post_with_endpoint_string.yaml b/ohsome/test/cassettes/test_client/test_post_with_endpoint_string.yaml
@@ -13,7 +13,7 @@ interactions:
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: POST
     uri: https://api.ohsome.org/v1/contributions/latest/bbox
   response:
@@ -50,7 +50,7 @@ interactions:
       Content-disposition:
       - attachment;filename=ohsome.geojson
       Date:
-      - Wed, 29 Nov 2023 14:33:58 GMT
+      - Wed, 06 Dec 2023 08:19:22 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:
@@ -78,7 +78,7 @@ interactions:
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: POST
     uri: https://api.ohsome.org/v1/contributions/latest/bbox
   response:
@@ -115,7 +115,7 @@ interactions:
       Content-disposition:
       - attachment;filename=ohsome.geojson
       Date:
-      - Wed, 29 Nov 2023 14:34:00 GMT
+      - Wed, 06 Dec 2023 08:19:24 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_user_agent.yaml b/ohsome/test/cassettes/test_client/test_user_agent.yaml
@@ -9,7 +9,7 @@ interactions:
       Connection:
       - keep-alive
       user-agent:
-      - ohsome-py/0.2.0
+      - ohsome-py/0.3.0
     method: GET
     uri: https://api.ohsome.org/v1/metadata
   response:
@@ -42,7 +42,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Wed, 29 Nov 2023 14:33:51 GMT
+      - Wed, 06 Dec 2023 08:19:10 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server: