kystdatahuset-python-lib 0.1.0__tar.gz

kystdatahuset_python_lib-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Kystverket
+
+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.

kystdatahuset_python_lib-0.1.0/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: kystdatahuset-python-lib
+Version: 0.1.0
+Summary: A python library for accessing and querying data from Kystdatahuset
+Author-email: Kystdatahuset developer team <support@kystdatahuset.no>, "(Stein) Runar Bergheim" <runar.bergheim@avinet.no>, Sigve Bergh <sigve.bergh@kystverket.no>, Hermann Klaus Kurt von Lupfert <hermann.lupfert@kystverket.no>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Kystverket/kystdatahuset-python-lib
+Project-URL: Repository, https://github.com/Kystverket/kystdatahuset-python-lib
+Project-URL: Issues, https://github.com/Kystverket/kystdatahuset-python-lib/issues
+Keywords: spatial,analytics,visualization,geodata
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24
+Requires-Dist: pandas>=2.0
+Requires-Dist: pydantic>=2.0
+Dynamic: license-file
+
+# Kystdatahuset Python Library
+
+A library to access and query Kystdatahuset

kystdatahuset_python_lib-0.1.0/README.md

@@ -0,0 +1,3 @@
+# Kystdatahuset Python Library
+
+A library to access and query Kystdatahuset

kystdatahuset_python_lib-0.1.0/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "kystdatahuset-python-lib"
+version = "0.1.0"
+description = "A python library for accessing and querying data from Kystdatahuset"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+  { name="Kystdatahuset developer team", email="support@kystdatahuset.no" },
+  { name="(Stein) Runar Bergheim", email="runar.bergheim@avinet.no" },
+  { name="Sigve Bergh", email="sigve.bergh@kystverket.no" },
+  { name="Hermann Klaus Kurt von Lupfert", email="hermann.lupfert@kystverket.no" },
+]
+classifiers = [
+  #   3 - Alpha
+  #   4 - Beta
+  #   5 - Production/Stable
+  "Development Status :: 4 - Beta",
+  # Indicate who your project is intended for
+  "Intended Audience :: Developers",
+  "Topic :: Software Development :: Libraries",
+  "Topic :: Scientific/Engineering :: Information Analysis",
+  # Specify the Python versions you support here.
+  "Programming Language :: Python :: 3.10",
+]
+license-files = ["LICEN[CS]E*"]
+keywords = ["spatial", "analytics", "visualization", "geodata"]
+dependencies = [
+  "numpy>=1.24",
+  "pandas>=2.0",
+  "pydantic>=2.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/Kystverket/kystdatahuset-python-lib"
+Repository = "https://github.com/Kystverket/kystdatahuset-python-lib"
+Issues = "https://github.com/Kystverket/kystdatahuset-python-lib/issues"
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]

kystdatahuset_python_lib-0.1.0/setup.cfg

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

kystdatahuset_python_lib-0.1.0/src/kystdatahuset/api_client.py

@@ -0,0 +1,103 @@
+from typing import Any, Dict, List, Tuple, Optional
+
+from kystdatahuset.models import WebServiceResponse
+from .const import API_URL
+import requests
+from kystdatahuset.logging import logger
+
+def get_headers(jwt_token: Optional[str] = None, json: bool = False) -> Dict[str, str]:
+    """
+    Build headers for API requests.
+    """
+    headers: Dict[str, str] = {}
+    if jwt_token:
+        headers["Authorization"] = f"Bearer {jwt_token}"
+    if json:
+        headers["Content-Type"] = "application/json"
+        headers["Accept"] = "application/json"
+    return headers
+
+
+def post_api_formdata(jwt_token: str, fragment: str, data: List[Tuple[str, Any]], filename: str) -> WebServiceResponse:
+    """
+    POST multipart/form-data with a file and form fields.
+    """
+    url = f"{API_URL}/{fragment}"
+
+    with open(filename, "rb") as f:
+        files = {"file": (filename, f, "application/octet-stream")}
+        response = requests.post(url, headers=get_headers(jwt_token), data=data, files=files)
+
+    if response.ok:
+        try:
+            logger.info(f"✅ POST (FormData) {url} successful!")
+            data = response.json()
+            return data
+        except ValueError:            
+            return WebServiceResponse[Any](**{"success": True, "msg": response.text, "data": None})
+    else:
+        logger.error(f"❌ POST (FormData) {url} failed with {response.status_code}")
+        logger.debug(response.text)
+        raise Exception(f"API POST (FormData) failed with status code {response.status_code}: {response.text}")
+
+
+def get_api(jwt_token: str, fragment: str, params: Optional[Dict[str, Any]] = None) -> WebServiceResponse:
+    """
+    Perform a GET request and parse JSON response.
+    """
+    url = f"{API_URL}/{fragment}"
+    response = requests.get(url, headers=get_headers(jwt_token, json=True), params=params)
+
+    if response.ok:
+        logger.info(f"✅ GET {url} successful!")
+        try:
+            data = response.json()
+            logger.debug(f"Response JSON: {data}")
+            return data
+        except ValueError:
+            return WebServiceResponse[str](**{"success": True, "msg": response.text, "data": None})
+    else:
+        logger.error(f"❌ GET {url} failed with {response.status_code}")
+        logger.debug(response.text)
+        raise Exception(f"API GET failed with status code {response.status_code}: {response.text}")
+
+def delete_api(jwt_token: str, fragment: str, params: Optional[Dict[str, Any]] = None) -> WebServiceResponse:
+    """
+    Perform a DELETE request and parse the JSON response.
+    """
+    url = f"{API_URL}/{fragment}"
+    response = requests.delete(url, headers=get_headers(jwt_token, json=True), params=params)
+
+    if response.ok:
+        logger.info(f"✅ DELETE {url} successful!")
+        try:
+            data = response.json()
+            logger.debug(f"Response JSON: {data}")
+            return data
+        except ValueError:
+            return WebServiceResponse[str](**{"success": True, "msg": response.text, "data": None})
+    else:
+        logger.error(f"❌ GET {url} failed with {response.status_code}")
+        logger.debug(response.text)
+        raise Exception(f"API GET failed with status code {response.status_code}: {response.text}")
+
+
+def post_api_json(jwt_token: str, fragment: str, payload: Dict[str, Any]) -> WebServiceResponse:
+    """
+    Perform a POST request with a JSON body and parse JSON response.
+    """
+    url = f"{API_URL}/{fragment}"
+    response = requests.post(url, headers=get_headers(jwt_token, json=True), json=payload)
+
+    if response.ok:
+        logger.info(f"✅ JSON POST to {url} successful!")
+        try:
+            data = response.json()
+            logger.debug(f"Response JSON: {data}")
+            return data
+        except ValueError:
+            return WebServiceResponse[str](**{"success": True, "message": response.text, "data": None})
+    else:
+        logger.error(f"❌ JSON POST to {url} failed with {response.status_code}")
+        logger.debug(response.text)
+        raise Exception(f"API JSON POST failed with status code {response.status_code}: {response.text}")

kystdatahuset_python_lib-0.1.0/src/kystdatahuset/auth.py

@@ -0,0 +1,30 @@
+import requests
+import json
+
+from kystdatahuset.models import AuthData, WebServiceResponse
+from kystdatahuset.logging import logger
+from .const import API_URL
+
+def login(username: str, password: str) -> WebServiceResponse[AuthData]:
+    reqUrl = f"{API_URL}/api/auth/login"
+
+    headersList = {
+        "User-Agent": "Kystdatahuset Python Library (https://your-client.com)",
+        "accept": "*/*",
+        "Content-Type": "application/json" 
+    }
+
+    payload = json.dumps({
+        "username": username,
+        "password": password
+    })
+
+    response = requests.request("POST", reqUrl, data=payload,  headers=headersList)
+
+    if response.status_code == 200:
+        logger.info("✅ Login successful!")
+        return WebServiceResponse[AuthData](**response.json()) 
+    else:
+        logger.error(f"❌ Login failed with status code {response.status_code}")
+        logger.debug(response.text)
+        raise Exception(f"Login failed with status code {response.status_code}: {response.text}")

kystdatahuset_python_lib-0.1.0/src/kystdatahuset/const.py

@@ -0,0 +1 @@
+API_URL="https://kystdatahuset.no/ws"

kystdatahuset_python_lib-0.1.0/src/kystdatahuset/file_storage.py

@@ -0,0 +1,54 @@
+from uuid import UUID
+from typing import Sequence, List
+from kystdatahuset.models import FileListing, WebServiceResponse
+from kystdatahuset.types import UploadFileType
+import os
+from kystdatahuset.api_client import post_api_formdata, get_api, delete_api
+
+def list(*, jwt_token: str, resource_uuid: UUID) -> List[FileListing]:
+    """
+    Placeholder for listing files in storage.
+    """
+    list_res = get_api(jwt_token, f"api/file-storage/list/{resource_uuid}")
+    file_listings = WebServiceResponse[List[FileListing]](**list_res)   
+    return file_listings.data
+
+def delete(* , jwt_token: str, file_uuid: UUID) -> bool:
+    """
+    Placeholder for deleting a file in storage.
+    """
+    delete_res = delete_api(jwt_token, f"api/file-storage/delete/{file_uuid}")
+    return delete_res.success
+
+def publish(
+    *,
+    jwt_token: str,
+    resource_uuid: UUID,
+    file_path: str,
+    title: str,
+    upload_file_type: UploadFileType,
+    description: str = "",
+    categories: Sequence[str] = "",
+    compressed: bool = False,
+) -> bool:
+    """
+    Upload a file and metadata to the Kystdatahuset API.
+    """
+
+    if not os.path.exists(file_path):
+        raise FileNotFoundError(f"File not found: {file_path}")
+
+    # Convert categories to multiple form fields (ASP.NET supports repeated keys)
+    # or as a JSON-like string, depending on the API’s binding expectations.
+    # The safe bet for ASP.NET [FromForm(Name="categories")] string[] is to repeat the key.
+    data = [
+        ("title", title),
+        ("description", description),
+        ("type", upload_file_type),
+        ("compressed", str(compressed).lower()),  # ASP.NET expects 'true'/'false'
+    ] + [("categories", c) for c in categories]
+
+    response = post_api_formdata(jwt_token, f"api/file-storage/publish/{resource_uuid}", data, file_path)
+    return response.success
+
+

kystdatahuset_python_lib-0.1.0/src/kystdatahuset/logging.py

@@ -0,0 +1,13 @@
+import logging
+
+logger_name = __name__.split(".")[0]
+# Create a logger specific to your library
+logger = logging.getLogger(logger_name)
+logger.addHandler(logging.NullHandler())
+
+def enable_default_logging(level=logging.INFO):
+    handler = logging.StreamHandler()
+    formatter = logging.Formatter("%(asctime)s [%(levelname)s] %(name)s: %(message)s")
+    handler.setFormatter(formatter)
+    logger.addHandler(handler)
+    logger.setLevel(level)

kystdatahuset_python_lib-0.1.0/src/kystdatahuset/models/AuthData.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel, Field
+from datetime import datetime
+
+
+class AuthData(BaseModel):
+    JWT: str = Field(..., description="JSON Web Token for authentication")
+    Username: str = Field(..., description="User's email or username")
+    Timestamp: datetime = Field(..., description="Timestamp when the token was issued")
+
+

kystdatahuset_python_lib-0.1.0/src/kystdatahuset/models/FileListing.py

@@ -0,0 +1,33 @@
+from pydantic import BaseModel, Field
+from typing import List
+from uuid import UUID
+
+
+class FileListing(BaseModel):
+    uuid: UUID = Field(..., description="Unique identifier for this file record")
+    title: str = Field(..., description="Title or display name of the uploaded file")
+    description: str = Field(..., description="Descriptive text about the file contents")
+    categories: List[str] = Field(..., description="List of category tags assigned to the file")
+    filetype: str = Field(..., description="Type or format of the uploaded file, e.g. csv, pdf")
+    compressed: bool = Field(..., description="True if the file was uploaded as compressed archive")
+    filename: str = Field(..., description="Server-side absolute file path")
+    origFilename: str = Field(..., description="Original filename on the client before upload")
+    resourceUuid: UUID = Field(..., description="UUID of the resource to which this file belongs")
+
+
+# # ✅ Example usage:
+# example_json = {
+#     'uuid': '69d47723-206c-4a89-8d67-654f23706e24',
+#     'title': 'Test Upload',
+#     'description': 'This is a test upload',
+#     'categories': ['test', 'upload'],
+#     'filetype': 'csv',
+#     'compressed': True,
+#     'filename': r'E:\storage\kystdathuset\catalog\2025\11\64\12\7f\64127fc2-2644-4ed9-b886-fecfb914c4b5\C_Users_runar.bergheim_Documents_Development_kystdatahuset-python-lib_test_data_content.txt',
+#     'origFilename': r'C:\\Users\\runar.bergheim\\Documents\\Development\\kystdatahuset-python-lib\\test_data\\content.txt',
+#     'resourceUuid': '64127fc2-2644-4ed9-b886-fecfb914c4b5'
+# }
+
+# listing = FileListing(**example_json)
+# print(listing.title)
+# print(listing.resourceUuid)

kystdatahuset_python_lib-0.1.0/src/kystdatahuset/models/WebServiceResponse.py

@@ -0,0 +1,11 @@
+from pydantic import Field, BaseModel
+from typing import Generic, TypeVar, Optional
+
+T = TypeVar("T")
+
+class WebServiceResponse(BaseModel, Generic[T]):
+    success: bool = Field(..., description="Indicates if the request was successful")
+    msg: str = Field(..., description="Optional message from the API")
+    data: Optional[T] = Field(None, description="Container for typed response data")
+    time: Optional[float] = Field(None, description="Processing time in milliseconds or seconds")
+    executionTime: Optional[float] = Field(None, description="Processing time in milliseconds or seconds")

kystdatahuset_python_lib-0.1.0/src/kystdatahuset/models/__init__.py

@@ -0,0 +1,3 @@
+from .AuthData import AuthData
+from .WebServiceResponse import WebServiceResponse
+from .FileListing import FileListing

kystdatahuset_python_lib-0.1.0/src/kystdatahuset/types/PandasFrequency.py

@@ -0,0 +1,8 @@
+from typing import Literal, TypeAlias
+
+PandasFreqency: TypeAlias = Literal[
+    "B", "C", "D", "W", "W-MON", "W-TUE", "W-WED", "W-THU", "W-FRI", "W-SAT", "W-SUN",
+    "M", "MS", "Q", "QS", "A", "AS",
+    "H", "T", "min", "S", "L", "ms", "U", "us", "N",
+    "BH", "CBH", "BQS", "BA", "BAS", "BYS", "BY"
+]

kystdatahuset_python_lib-0.1.0/src/kystdatahuset/types/UploadFileType.py

@@ -0,0 +1,18 @@
+from typing import Literal, TypeAlias
+
+UploadFileType: TypeAlias = Literal[
+    "csv",              # Comma Separated Variables
+    "shp-compressed",   # Compressed ESRI Shapefile
+    "fgdb-compressed",  # Compressed ESRI filegeodatabase
+    "json",             # JSON file
+    "geojson",          # GeoJSON file
+    "png",              # Portable Network Graphics image
+    "jpg",              # JPEG image
+    "pdf",              # Portable Document Format
+    "xlsx",             # Microsoft Excel spreadsheet
+    "xml",              # XML file
+    "docx",             # Microsoft Word document
+    "NetCDF",           # Network Common Data Form (NetCDF)
+    "tiff",             # Tagged Image File Format (*.tif)
+    "geotiff",          # Georeferenced Tagged Image File Format (*.tif)
+]

kystdatahuset_python_lib-0.1.0/src/kystdatahuset/types/__init__.py

@@ -0,0 +1,2 @@
+from .PandasFrequency import PandasFreqency
+from .UploadFileType import UploadFileType

kystdatahuset_python_lib-0.1.0/src/kystdatahuset/utils/date_range.py

@@ -0,0 +1,14 @@
+from typing import List, Optional, Tuple
+
+from datetime import datetime, timedelta
+from kystdatahuset.types import PandasFreqency
+
+def date_range2(start_date: datetime, end_date: datetime, freq: PandasFreqency) -> List[datetime]:
+    """
+    Generate a list of dates from start_date to end_date, inclusive.
+    """
+    if start_date > end_date:
+        raise ValueError("start_date must be less than or equal to end_date")
+    
+    delta = end_date - start_date
+    return [start_date + timedelta(days=i) for i in range(delta.days + 1)]

kystdatahuset_python_lib-0.1.0/src/kystdatahuset_python_lib.egg-info/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: kystdatahuset-python-lib
+Version: 0.1.0
+Summary: A python library for accessing and querying data from Kystdatahuset
+Author-email: Kystdatahuset developer team <support@kystdatahuset.no>, "(Stein) Runar Bergheim" <runar.bergheim@avinet.no>, Sigve Bergh <sigve.bergh@kystverket.no>, Hermann Klaus Kurt von Lupfert <hermann.lupfert@kystverket.no>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Kystverket/kystdatahuset-python-lib
+Project-URL: Repository, https://github.com/Kystverket/kystdatahuset-python-lib
+Project-URL: Issues, https://github.com/Kystverket/kystdatahuset-python-lib/issues
+Keywords: spatial,analytics,visualization,geodata
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24
+Requires-Dist: pandas>=2.0
+Requires-Dist: pydantic>=2.0
+Dynamic: license-file
+
+# Kystdatahuset Python Library
+
+A library to access and query Kystdatahuset

kystdatahuset_python_lib-0.1.0/src/kystdatahuset_python_lib.egg-info/SOURCES.txt

@@ -0,0 +1,27 @@
+LICENSE
+README.md
+pyproject.toml
+src/__init__.py
+src/kystdatahuset/__init__.py
+src/kystdatahuset/api_client.py
+src/kystdatahuset/auth.py
+src/kystdatahuset/const.py
+src/kystdatahuset/file_storage.py
+src/kystdatahuset/logging.py
+src/kystdatahuset/voyages.py
+src/kystdatahuset/models/AuthData.py
+src/kystdatahuset/models/FileListing.py
+src/kystdatahuset/models/WebServiceResponse.py
+src/kystdatahuset/models/__init__.py
+src/kystdatahuset/types/PandasFrequency.py
+src/kystdatahuset/types/UploadFileType.py
+src/kystdatahuset/types/__init__.py
+src/kystdatahuset/utils/__init__.py
+src/kystdatahuset/utils/date_range.py
+src/kystdatahuset_python_lib.egg-info/PKG-INFO
+src/kystdatahuset_python_lib.egg-info/SOURCES.txt
+src/kystdatahuset_python_lib.egg-info/dependency_links.txt
+src/kystdatahuset_python_lib.egg-info/requires.txt
+src/kystdatahuset_python_lib.egg-info/top_level.txt
+tests/test_auth.py
+tests/test_file_storage.py

kystdatahuset_python_lib-0.1.0/src/kystdatahuset_python_lib.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

kystdatahuset_python_lib-0.1.0/src/kystdatahuset_python_lib.egg-info/requires.txt

@@ -0,0 +1,3 @@
+numpy>=1.24
+pandas>=2.0
+pydantic>=2.0

kystdatahuset_python_lib-0.1.0/src/kystdatahuset_python_lib.egg-info/top_level.txt

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

kystdatahuset_python_lib-0.1.0/tests/test_auth.py

@@ -0,0 +1,8 @@
+from kystdatahuset.auth import login
+import os
+
+def test_login_success():
+    response = login(os.getenv("TEST_USERNAME"), os.getenv("TEST_PASSWORD"))
+    assert response is not None, "Expected a response, got None"
+    assert response.data is not None, "Response does not contain 'data'"
+    assert response.data.JWT is not None, "Response 'data' does not contain 'JWT'"

kystdatahuset_python_lib-0.1.0/tests/test_file_storage.py

@@ -0,0 +1,16 @@
+from kystdatahuset.file_storage import publish, list, delete
+from uuid import UUID
+from typing import List
+
+def test_list(auth_jwt):
+    list_res = list(jwt_token=auth_jwt, resource_uuid=UUID("64127fc2-2644-4ed9-b886-fecfb914c4b5"))
+    assert isinstance(list_res, List) and len(list_res) >= 0, "Expected non-empty file list"
+
+def test_publish(upload_filename, auth_jwt):
+    publish_res = publish(jwt_token=auth_jwt, resource_uuid=UUID("64127fc2-2644-4ed9-b886-fecfb914c4b5"), file_path=upload_filename, title="Test Upload", upload_file_type="csv", description="This is a test upload", categories=["test", "upload"], compressed=True)
+    assert publish_res is not None, "Expected publish to return True"
+
+def test_delete(auth_jwt):
+    list_res = list(jwt_token=auth_jwt, resource_uuid=UUID("64127fc2-2644-4ed9-b886-fecfb914c4b5"))
+    delete_res = delete(jwt_token=auth_jwt, file_uuid=list_res[0].uuid)
+    assert delete_res == True, "Expected delete to return True"