grawgo 2.0.0__tar.gz

grawgo-2.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 GRAW Radiosondes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

grawgo-2.0.0/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.4
+Name: grawgo
+Version: 2.0.0
+Summary: A python lib to use the grawGo api
+Author-email: Niklas Wildenburg <niklas.wildenburg@graw.de>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/GrawRadiosondes/grawgo-python-api
+Project-URL: Bug Tracker, https://github.com/GrawRadiosondes/grawgo-python-api/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests~=2.34.0
+Dynamic: license-file
+
+# grawGo API
+
+## Release
+
+1. `ruff format`
+2. Bump version in [pyproject.toml](pyproject.toml)
+3. Commit
+4. Apply SemVer tag
+5. Push commit and tag

grawgo-2.0.0/README.md

@@ -0,0 +1,9 @@
+# grawGo API
+
+## Release
+
+1. `ruff format`
+2. Bump version in [pyproject.toml](pyproject.toml)
+3. Commit
+4. Apply SemVer tag
+5. Push commit and tag

grawgo-2.0.0/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=74.1.1"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "grawgo"
+version = "2.0.0"
+description = "A python lib to use the grawGo api"
+readme = "README.md"
+requires-python = ">=3.14"
+license = "MIT"
+authors = [{ name = "Niklas Wildenburg", email = "niklas.wildenburg@graw.de" }]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent"
+]
+dependencies = ["requests~=2.34.0"]
+
+[dependency-groups]
+"dev" = ["pytest~=9.0.3", "Faker~=40.15.0", "python-dotenv~=1.2.2"]
+
+[project.urls]
+"Homepage" = "https://github.com/GrawRadiosondes/grawgo-python-api"
+"Bug Tracker" = "https://github.com/GrawRadiosondes/grawgo-python-api/issues"
+
+[tool.pytest.ini_options]
+filterwarnings = [
+    "ignore::urllib3.exceptions.InsecureRequestWarning"
+]

grawgo-2.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

grawgo-2.0.0/src/grawgo/__init__.py

@@ -0,0 +1,9 @@
+import logging
+from os import getenv
+
+logging.basicConfig(
+    level=getattr(
+        logging, getenv(key="LOG_LEVEL", default="INFO").upper(), logging.INFO
+    ),
+    format="%(levelname)s: %(message)s",
+)

grawgo-2.0.0/src/grawgo/api.py

@@ -0,0 +1,179 @@
+from logging import info
+from typing import Any
+from urllib.parse import urlparse
+
+from requests import Response, get, post
+
+
+class Api:
+    def __init__(
+        self,
+        base_url: str,
+        username: str = "",
+        password: str = "",
+        logging: bool = False,
+    ) -> None:
+        self.base_url: str = base_url
+        self.auth: tuple[str, str] = (username, password)
+        self.logging: bool = logging
+        self.verify_https: bool = urlparse(self.base_url).hostname != "localhost"
+
+    def log(self, message: str | dict[str, Any]) -> None:
+        if self.logging:
+            if isinstance(message, dict) and "password" in message:
+                message = {**message, "password": "[REDACTED]"}
+
+            info(msg=message)
+
+    def log_response(self, response: Response) -> None:
+        if self.logging and not response.ok:
+            info(msg=response.status_code)
+            info(msg=response.content)
+
+    def get(self, path: str, authorized: bool = True) -> Response:
+        self.log(message=f"GET {self.base_url}/{path}")
+
+        auth = None
+        if authorized:
+            auth = self.auth
+
+        response: Response = get(
+            url=f"{self.base_url}/{path}",
+            headers={
+                "Accept": "application/json",
+            },
+            auth=auth,
+            verify=self.verify_https,
+        )
+
+        self.log_response(response=response)
+        return response
+
+    def post(self, path: str, json: Any) -> Response:
+        # TODO: fix for list in json instead of dict
+        # sanitized_json: dict[str, Any] = {**json}
+        # if "password" in sanitized_json:
+        #    sanitized_json["password"] = "[REDACTED]"
+        # self.log(message=f"POST {self.base_url}/{path} {sanitized_json}")
+
+        response: Response = post(
+            url=f"{self.base_url}/{path}",
+            headers={"Accept": "application/json", "Content-Type": "application/json"},
+            auth=self.auth,
+            json=json,
+            verify=self.verify_https,
+        )
+
+        self.log_response(response=response)
+        return response
+
+    def status(self) -> Response:
+        return self.get(path="status", authorized=False)
+
+    def user_self(self) -> Response:
+        return self.get(path="user/self")
+
+    def user_self_stations(self) -> list[Any]:
+        return self.user_self().json()["data"]["stations"]
+
+    def user_self_first_station(self):
+        return self.user_self_stations()[0]
+
+    def create_user(self, email: str, password: str, role: str, name: str) -> Response:
+        return self.post(
+            path="user",
+            json={
+                "email": email,
+                "password": password,
+                "role": role,
+                "name": name,
+            },
+        )
+
+    def create_station(
+        self,
+        name: str,
+        operation_type: str,
+        wmo_id: int,
+        latitude: float,
+        longitude: float,
+        altitude: float,
+    ) -> Response:
+        return self.post(
+            path="station",
+            json={
+                "name": name,
+                "type": operation_type,
+                "wmo_id": wmo_id,
+                "latitude": latitude,
+                "longitude": longitude,
+                "altitude": altitude,
+            },
+        )
+
+    def create_flight(
+        self,
+        station_id: int,
+        status: str,
+        sonde_serial: str,
+        set_frequency: float,
+        sonde_firmware_version: str,
+    ) -> Response:
+        return self.post(
+            path="flight",
+            json={
+                "station_id": station_id,
+                "status": status,
+                "sonde_serial": sonde_serial,
+                "set_frequency": set_frequency,
+                "sonde_firmware_version": sonde_firmware_version,
+            },
+        )
+
+    def create_measurement(
+        self,
+        flight_id: int,
+        time_after_launch: int,
+        utc_time: str,
+        pressure: float,
+        temperature: float,
+        humidity: float,
+        wind_speed: float,
+        wind_direction: float,
+        latitude: float,
+        longitude: float,
+        altitude: float,
+        vertical_speed: float,
+        geo_potential: float,
+        dew_point: float,
+        elevation: float,
+        azimuth: float,
+        distance: float,
+    ) -> Response:
+        return self.post(
+            path="measurement",
+            json=[
+                {
+                    "flight_id": flight_id,
+                    "time_after_launch": time_after_launch,
+                    "utc_time": utc_time,
+                    "pressure": pressure,
+                    "temperature": temperature,
+                    "humidity": humidity,
+                    "wind_speed": wind_speed,
+                    "wind_direction": wind_direction,
+                    "latitude": latitude,
+                    "longitude": longitude,
+                    "altitude": altitude,
+                    "vertical_speed": vertical_speed,
+                    "geo_potential": geo_potential,
+                    "dew_point": dew_point,
+                    "elevation": elevation,
+                    "azimuth": azimuth,
+                    "distance": distance,
+                },
+            ],
+        )
+
+    def attach_station_to_user(self, user_id: int, station_id: int) -> Response:
+        return self.post(path=f"user/{user_id}/attachStation/{station_id}", json={})

grawgo-2.0.0/src/grawgo.egg-info/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.4
+Name: grawgo
+Version: 2.0.0
+Summary: A python lib to use the grawGo api
+Author-email: Niklas Wildenburg <niklas.wildenburg@graw.de>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/GrawRadiosondes/grawgo-python-api
+Project-URL: Bug Tracker, https://github.com/GrawRadiosondes/grawgo-python-api/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests~=2.34.0
+Dynamic: license-file
+
+# grawGo API
+
+## Release
+
+1. `ruff format`
+2. Bump version in [pyproject.toml](pyproject.toml)
+3. Commit
+4. Apply SemVer tag
+5. Push commit and tag

grawgo-2.0.0/src/grawgo.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+pyproject.toml
+src/__init__.py
+src/grawgo/__init__.py
+src/grawgo/api.py
+src/grawgo/py.typed
+src/grawgo.egg-info/PKG-INFO
+src/grawgo.egg-info/SOURCES.txt
+src/grawgo.egg-info/dependency_links.txt
+src/grawgo.egg-info/requires.txt
+src/grawgo.egg-info/top_level.txt
+tests/test_api_as_admin.py
+tests/test_api_as_api.py
+tests/test_api_as_public.py

grawgo-2.0.0/src/grawgo.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

grawgo-2.0.0/src/grawgo.egg-info/requires.txt

@@ -0,0 +1 @@
+requests~=2.34.0

grawgo-2.0.0/src/grawgo.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+__init__
+grawgo

grawgo-2.0.0/tests/test_api_as_admin.py

@@ -0,0 +1,71 @@
+import pytest
+from faker import Faker
+from requests import codes
+
+from grawgo.api import Api
+
+
+def test_user_self(api_as_admin: Api):
+    assert api_as_admin.user_self().status_code == codes.ok
+
+
+def test_user_self_stations(api_as_admin: Api):
+    assert isinstance(api_as_admin.user_self_stations(), list)
+
+
+@pytest.mark.parametrize("role", ["admin", "station_admin", "user", "api"])
+def test_create_user(api_as_admin: Api, faker: Faker, role: str):
+    assert (
+        api_as_admin.create_user(
+            faker.email(),
+            faker.password(),
+            role,
+            faker.name(),
+        ).status_code
+        == codes.created
+    )
+
+
+@pytest.mark.parametrize("type", ["selerys", "operated_fixed", "operated_mobile"])
+def test_create_station(api_as_admin: Api, faker: Faker, type: str):
+    assert (
+        api_as_admin.create_station(
+            faker.name(),
+            type,
+            faker.random_int(10000, 99999),
+            float(faker.latitude()),
+            float(faker.longitude()),
+            faker.random_int(min=0, max=8848),
+        ).status_code
+        == codes.created
+    )
+
+
+@pytest.mark.parametrize("role", ["admin", "station_admin", "user", "api"])
+@pytest.mark.parametrize("type", ["selerys", "operated_fixed", "operated_mobile"])
+def test_attach_station_to_user(api_as_admin: Api, faker: Faker, role: str, type: str):
+    username = faker.email()
+    password = faker.password()
+    user = api_as_admin.create_user(username, password, role, faker.name()).json()
+    user_api = Api(api_as_admin.base_url, username, password)
+
+    assert len(user_api.user_self_stations()) == 0
+
+    station = api_as_admin.create_station(
+        faker.name(),
+        type,
+        faker.random_int(10000, 99999),
+        float(faker.latitude()),
+        float(faker.longitude()),
+        faker.random_int(min=0, max=8848),
+    ).json()
+    assert (
+        api_as_admin.attach_station_to_user(
+            user["data"]["id"], station["data"]["id"]
+        ).status_code
+        == codes.ok
+    )
+
+    stations = user_api.user_self_stations()
+    assert len(stations) == 1
+    assert station == stations[0]

grawgo-2.0.0/tests/test_api_as_api.py

@@ -0,0 +1,56 @@
+from faker import Faker
+from requests import codes
+
+from grawgo.api import Api
+
+
+def test_user_self(api_as_api: Api):
+    assert api_as_api.user_self().status_code == codes.ok
+
+
+def test_user_self_first_station(api_as_api: Api):
+    assert api_as_api.user_self_first_station()
+
+
+def test_create_flight(api_as_api: Api, faker: Faker):
+    assert (
+        api_as_api.create_flight(
+            station_id=api_as_api.user_self_first_station()["data"]["id"],
+            status="created",
+            sonde_serial=faker.name(),
+            set_frequency=faker.random_int(min=400, max=406),
+            sonde_firmware_version=faker.name(),
+        ).status_code
+        == codes.created
+    )
+
+
+def test_create_measurement(api_as_api: Api, faker: Faker):
+    assert (
+        api_as_api.create_measurement(
+            flight_id=api_as_api.create_flight(
+                station_id=api_as_api.user_self_first_station()["data"]["id"],
+                status="created",
+                sonde_serial=faker.name(),
+                set_frequency=faker.random_int(min=400, max=406),
+                sonde_firmware_version=faker.name(),
+            ).json()["data"]["id"],
+            time_after_launch=0,
+            utc_time="00:00:00",
+            pressure=0,
+            temperature=0,
+            humidity=0,
+            wind_speed=0,
+            wind_direction=0,
+            latitude=0,
+            longitude=0,
+            altitude=0,
+            vertical_speed=0,
+            geo_potential=0,
+            dew_point=0,
+            elevation=0,
+            azimuth=0,
+            distance=0,
+        ).status_code
+        == codes.created
+    )

grawgo-2.0.0/tests/test_api_as_public.py

@@ -0,0 +1,7 @@
+from requests import codes
+
+from grawgo.api import Api
+
+
+def test_status(api_as_public: Api):
+    assert api_as_public.status().status_code == codes.ok