huwise-utils-py 1.0.0__tar.gz

huwise_utils_py-1.0.0/.gitignore

@@ -0,0 +1,139 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+**/*.env
+**/*.venv/
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Website links
+*.url
+
+# Credential files. Should not exist in this project, but in case they do, we don't want to accidentally upload them
+**/credentials.py

huwise_utils_py-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Open Data Basel-Stadt
+
+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.

huwise_utils_py-1.0.0/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: huwise-utils-py
+Version: 1.0.0
+Summary: A Python wrapper library for the Huwise Automation API
+Project-URL: Homepage, https://github.com/opendatabs/huwise-utils-py
+Project-URL: Documentation, https://opendatabs.github.io/huwise-utils-py
+Project-URL: Repository, https://github.com/opendatabs/huwise-utils-py.git
+Project-URL: Issues, https://github.com/opendatabs/huwise-utils-py/issues
+Project-URL: Coding Standards, https://dcc-bs.github.io/documentation/coding/python.html
+Author-email: Open Data Basel-Stadt <opendata@bs.ch>, Renato Farruggio <renato.farruggio@bs.ch>, Rstam Alosuh <rstam.aloush@bs.ch>, Orhan Saeedi <orhan.saeedi@bs.ch>
+License: MIT License
+        
+        Copyright (c) 2024 Open Data Basel-Stadt
+        
+        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.
+License-File: LICENSE
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Requires-Dist: dcc-backend-common>=0.1.4
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: rich>=14.3.2
+Description-Content-Type: text/markdown
+
+# huwise-utils-py
+
+A Python library for the Huwise Automation API.
+
+[![PyPI version](https://badge.fury.io/py/huwise-utils-py.svg)](https://badge.fury.io/py/huwise-utils-py)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Features
+
+- **Type-safe configuration** with Pydantic-based `HuwiseConfig`
+- **Object-oriented API** with `HuwiseDataset` class and method chaining
+- **Async support** for high-performance bulk operations
+- **Structured logging** via `dcc-backend-common`
+- **Dependency injection** support for testable code
+- **Backwards compatible** function-based API available
+
+## Installation
+
+Using `uv` (recommended):
+
+```bash
+uv add huwise-utils-py
+```
+
+Or via `pip`:
+
+```bash
+pip install huwise-utils-py
+```
+
+## Requirements
+
+- **Python Version:** 3.12 or higher
+- **API Key:** A valid API key from Huwise
+
+## Quick Start
+
+### Configuration
+
+Create a `.env` file:
+
+```bash
+HUWISE_API_KEY=your-api-key
+HUWISE_DOMAIN=data.bs.ch
+HUWISE_API_TYPE=automation/v1.0
+```
+
+### Using HuwiseDataset (Recommended)
+
+```python
+from huwise_utils_py import HuwiseDataset
+
+# Create a dataset instance
+dataset = HuwiseDataset(uid="da_abc123")
+
+# Read metadata
+title = dataset.get_title()
+description = dataset.get_description()
+
+# Update with method chaining
+dataset.set_title("New Title", publish=False) \
+       .set_description("New description") \
+       .publish()
+```
+
+### Using Functions
+
+```python
+from huwise_utils_py import get_dataset_title, set_dataset_title
+
+# Read
+title = get_dataset_title(dataset_uid="da_abc123")
+
+# Write
+set_dataset_title("New Title", dataset_uid="da_abc123")
+```
+
+### Bulk Operations
+
+```python
+from huwise_utils_py import bulk_get_metadata, bulk_get_metadata_async
+import asyncio
+
+# Synchronous
+metadata = bulk_get_metadata(["da_123", "da_456", "da_789"])
+
+# Asynchronous (10-100x faster for many datasets)
+metadata = asyncio.run(bulk_get_metadata_async(["da_123", "da_456", "da_789"]))
+```
+
+## API Key Setup
+
+To use `huwise-utils-py`, create an API key with these permissions:
+
+- Browse all datasets
+- Create new datasets
+- Edit all datasets
+- Publish own datasets
+
+[For OGD Basel, create your API key here](https://data.bs.ch/account/api-keys/).
+
+**Important:** Add `**/.env` to your `.gitignore` to protect your credentials.
+
+## Documentation
+
+Full documentation is available at [opendatabs.github.io/huwise-utils-py](https://opendatabs.github.io/huwise-utils-py).
+
+## Further Links
+
+- [GitHub Repository](https://github.com/opendatabs/huwise-utils-py)
+- [PyPI Package](https://pypi.org/project/huwise-utils-py/)
+- [Huwise Automation API Documentation](https://help.opendatasoft.com/apis/ods-automation-v1/)
+- [DCC Python Coding Standards](https://dcc-bs.github.io/documentation/coding/python.html)
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

huwise_utils_py-1.0.0/README.md

@@ -0,0 +1,118 @@
+# huwise-utils-py
+
+A Python library for the Huwise Automation API.
+
+[![PyPI version](https://badge.fury.io/py/huwise-utils-py.svg)](https://badge.fury.io/py/huwise-utils-py)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Features
+
+- **Type-safe configuration** with Pydantic-based `HuwiseConfig`
+- **Object-oriented API** with `HuwiseDataset` class and method chaining
+- **Async support** for high-performance bulk operations
+- **Structured logging** via `dcc-backend-common`
+- **Dependency injection** support for testable code
+- **Backwards compatible** function-based API available
+
+## Installation
+
+Using `uv` (recommended):
+
+```bash
+uv add huwise-utils-py
+```
+
+Or via `pip`:
+
+```bash
+pip install huwise-utils-py
+```
+
+## Requirements
+
+- **Python Version:** 3.12 or higher
+- **API Key:** A valid API key from Huwise
+
+## Quick Start
+
+### Configuration
+
+Create a `.env` file:
+
+```bash
+HUWISE_API_KEY=your-api-key
+HUWISE_DOMAIN=data.bs.ch
+HUWISE_API_TYPE=automation/v1.0
+```
+
+### Using HuwiseDataset (Recommended)
+
+```python
+from huwise_utils_py import HuwiseDataset
+
+# Create a dataset instance
+dataset = HuwiseDataset(uid="da_abc123")
+
+# Read metadata
+title = dataset.get_title()
+description = dataset.get_description()
+
+# Update with method chaining
+dataset.set_title("New Title", publish=False) \
+       .set_description("New description") \
+       .publish()
+```
+
+### Using Functions
+
+```python
+from huwise_utils_py import get_dataset_title, set_dataset_title
+
+# Read
+title = get_dataset_title(dataset_uid="da_abc123")
+
+# Write
+set_dataset_title("New Title", dataset_uid="da_abc123")
+```
+
+### Bulk Operations
+
+```python
+from huwise_utils_py import bulk_get_metadata, bulk_get_metadata_async
+import asyncio
+
+# Synchronous
+metadata = bulk_get_metadata(["da_123", "da_456", "da_789"])
+
+# Asynchronous (10-100x faster for many datasets)
+metadata = asyncio.run(bulk_get_metadata_async(["da_123", "da_456", "da_789"]))
+```
+
+## API Key Setup
+
+To use `huwise-utils-py`, create an API key with these permissions:
+
+- Browse all datasets
+- Create new datasets
+- Edit all datasets
+- Publish own datasets
+
+[For OGD Basel, create your API key here](https://data.bs.ch/account/api-keys/).
+
+**Important:** Add `**/.env` to your `.gitignore` to protect your credentials.
+
+## Documentation
+
+Full documentation is available at [opendatabs.github.io/huwise-utils-py](https://opendatabs.github.io/huwise-utils-py).
+
+## Further Links
+
+- [GitHub Repository](https://github.com/opendatabs/huwise-utils-py)
+- [PyPI Package](https://pypi.org/project/huwise-utils-py/)
+- [Huwise Automation API Documentation](https://help.opendatasoft.com/apis/ods-automation-v1/)
+- [DCC Python Coding Standards](https://dcc-bs.github.io/documentation/coding/python.html)
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

huwise_utils_py-1.0.0/pyproject.toml

@@ -0,0 +1,128 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "huwise-utils-py"
+version = "1.0.0"
+description = "A Python wrapper library for the Huwise Automation API"
+readme = "README.md"
+license = {file = "LICENSE"}
+authors = [
+    {name = "Open Data Basel-Stadt", email = "opendata@bs.ch"},
+    {name = "Renato Farruggio", email = "renato.farruggio@bs.ch"},
+    {name = "Rstam Alosuh", email = "rstam.aloush@bs.ch"},
+    {name = "Orhan Saeedi", email = "orhan.saeedi@bs.ch"},
+]
+requires-python = ">=3.12"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "dcc-backend-common>=0.1.4",
+    "httpx>=0.27.0",
+    "rich>=14.3.2",
+]
+
+[project.urls]
+Homepage = "https://github.com/opendatabs/huwise-utils-py"
+Documentation = "https://opendatabs.github.io/huwise-utils-py"
+Repository = "https://github.com/opendatabs/huwise-utils-py.git"
+Issues = "https://github.com/opendatabs/huwise-utils-py/issues"
+"Coding Standards" = "https://dcc-bs.github.io/documentation/coding/python.html"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.23.0",
+    "ruff>=0.9.0",
+    "ty>=0.0.9",
+    "pre-commit>=4.0.0",
+    "coverage>=7.6.0",
+]
+docs = [
+    "mkdocs-material>=9.5.0",
+    "mkdocstrings[python]>=0.24.0",
+]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/huwise_utils_py"]
+
+[tool.ruff]
+target-version = "py312"
+line-length = 120
+fix = true
+
+[tool.ruff.lint]
+select = [
+    # flake8-2020
+    "YTT",
+    # flake8-bandit
+    "S",
+    # flake8-bugbear
+    "B",
+    # flake8-builtins
+    "A",
+    # flake8-comprehensions
+    "C4",
+    # flake8-debugger
+    "T10",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I",
+    # mccabe
+    "C90",
+    # pycodestyle
+    "E", "W",
+    # pyflakes
+    "F",
+    # pygrep-hooks
+    "PGH",
+    # pyupgrade
+    "UP",
+    # ruff
+    "RUF",
+    # tryceratops
+    "TRY",
+]
+ignore = [
+    # LineTooLong
+    "E501",
+    # DoNotAssignLambda
+    "E731",
+    "TRY003",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["S101"]
+
+[tool.ruff.format]
+preview = true
+indent-style = "space"
+quote-style = "double"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.ruff.lint.isort]
+known-first-party = ["huwise_utils_py"]
+combine-as-imports = true
+force-wrap-aliases = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_functions = ["test_*"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"

huwise_utils_py-1.0.0/src/huwise_utils_py/__init__.py

@@ -0,0 +1,110 @@
+"""Huwise Utils Python - A Python wrapper library for the Huwise Automation API.
+
+This package provides a modern, type-safe interface for interacting with the Huwise
+(formerly OpenDataSoft) Automation API to manage datasets, metadata, and more.
+
+Example:
+    >>> from huwise_utils_py import HuwiseDataset
+    >>> dataset = HuwiseDataset(uid="da_abc123")
+    >>> dataset.set_title("New Title").set_description("Description").publish()
+
+For function-based API:
+    >>> from huwise_utils_py import get_dataset_title, set_dataset_title
+    >>> title = get_dataset_title(dataset_uid="da_abc123")
+"""
+
+# Function-based API
+from huwise_utils_py._legacy import (
+    get_all_dataset_ids,
+    get_dataset_custom_view,
+    get_dataset_description,
+    get_dataset_keywords,
+    get_dataset_language,
+    get_dataset_license,
+    get_dataset_metadata,
+    get_dataset_metadata_temporal_period,
+    get_dataset_publisher,
+    get_dataset_theme,
+    get_dataset_title,
+    get_number_of_datasets,
+    get_template_metadata,
+    get_uid_by_id,
+    set_dataset_description,
+    set_dataset_keywords,
+    set_dataset_language,
+    set_dataset_license,
+    set_dataset_metadata_temporal_coverage_end_date,
+    set_dataset_metadata_temporal_coverage_start_date,
+    set_dataset_metadata_temporal_period,
+    set_dataset_public,
+    set_dataset_publisher,
+    set_dataset_theme,
+    set_dataset_title,
+    set_template_metadata,
+)
+from huwise_utils_py.bulk import (
+    bulk_get_dataset_ids,
+    bulk_get_dataset_ids_async,
+    bulk_get_metadata,
+    bulk_get_metadata_async,
+    bulk_update_metadata,
+    bulk_update_metadata_async,
+)
+from huwise_utils_py.config import HuwiseConfig
+from huwise_utils_py.dataset import HuwiseDataset
+from huwise_utils_py.http import AsyncHttpClient, HttpClient
+from huwise_utils_py.logger import get_logger, init_logger
+
+# Utilities
+from huwise_utils_py.utils import retry, validate_dataset_identifier
+
+__version__ = "1.0.0"
+
+__all__ = [
+    "AsyncHttpClient",
+    "HttpClient",
+    # Core components (new API)
+    "HuwiseConfig",
+    "HuwiseDataset",
+    # Version
+    "__version__",
+    "bulk_get_dataset_ids",
+    "bulk_get_dataset_ids_async",
+    # Bulk operations (new API)
+    "bulk_get_metadata",
+    "bulk_get_metadata_async",
+    "bulk_update_metadata",
+    "bulk_update_metadata_async",
+    # Function-based API
+    "get_all_dataset_ids",
+    "get_dataset_custom_view",
+    "get_dataset_description",
+    "get_dataset_keywords",
+    "get_dataset_language",
+    "get_dataset_license",
+    "get_dataset_metadata",
+    "get_dataset_metadata_temporal_period",
+    "get_dataset_publisher",
+    "get_dataset_theme",
+    "get_dataset_title",
+    "get_logger",
+    "get_number_of_datasets",
+    "get_template_metadata",
+    "get_uid_by_id",
+    "init_logger",
+    # Utilities
+    "retry",
+    "set_dataset_description",
+    "set_dataset_keywords",
+    "set_dataset_language",
+    "set_dataset_license",
+    "set_dataset_metadata_temporal_coverage_end_date",
+    "set_dataset_metadata_temporal_coverage_start_date",
+    "set_dataset_metadata_temporal_period",
+    "set_dataset_public",
+    "set_dataset_publisher",
+    "set_dataset_theme",
+    "set_dataset_title",
+    "set_template_metadata",
+    "validate_dataset_identifier",
+]