pygidata 0.4.1__tar.gz

pygidata-0.4.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Gantner Instruments GmbH. All rights reserved.
+
+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.

pygidata-0.4.1/PKG-INFO

@@ -0,0 +1,212 @@
+Metadata-Version: 2.4
+Name: pygidata
+Version: 0.4.1
+Summary: Python package providing an interface to the Gantner Instruments Data API
+Author: Gantner Instruments GmbH
+Keywords: python
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: <3.13,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiokafka
+Requires-Dist: certifi
+Requires-Dist: httpx
+Requires-Dist: nest_asyncio
+Requires-Dist: pandas
+Requires-Dist: pydantic
+Requires-Dist: websockets
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-xdist; extra == "test"
+Dynamic: license-file
+
+# pygidata
+
+# Usage
+
+### Install from PyPi
+
+```bash 
+pip install pygidata
+```
+
+Import module in python script and call functions.
+
+A detailed description of the package and other APIs can be found under [docs/](docs/Usage.ipynb) or in the
+Gantner Documentation.
+
+```python
+from gi_data.dataclient import GIDataClient
+import os
+
+PROFILES = {
+    "qstation": {
+        "base": os.getenv("GI_QSTATION_BASE", "http://10.1.50.36:8090"),
+        "auth": {"username": os.getenv("GI_QSTATION_USER", "admin"),
+                 "password": os.getenv("GI_QSTATION_PASS", "admin")},
+    },
+    "cloud": {
+        "base": os.getenv("GI_CLOUD_BASE", "https://demo.gi-cloud.io"),
+        "auth": {"access_token": os.getenv("GI_CLOUD_TOKEN", "")},
+    },
+}
+
+ACTIVE_PROFILE = os.getenv("GI_PROFILE", "qstation")
+
+def get_client(profile: str = ACTIVE_PROFILE) -> GIDataClient:
+    cfg = PROFILES[profile]
+    if cfg["auth"].get("access_token"):
+        return GIDataClient(cfg["base"], access_token=cfg["auth"]["access_token"]) 
+    return GIDataClient(cfg["base"],
+                        username=cfg["auth"].get("username"),
+                        password=cfg["auth"].get("password"))
+
+client = get_client()
+
+```
+
+
+# Development
+
+### Used as submodule in
+* gi-sphinx
+* gi-jupyterlab
+* gi-analytics-examples
+
+### Information on how to manually distribute this package can be found here
+
+https://packaging.python.org/en/latest/tutorials/packaging-projects/
+
+**Hint:** If you are debugging the source code with a jupyter notebook, run this code in the `first cell` to enable autoreloading source code changes.
+
+```bash
+%load_ext autoreload
+%autoreload 2
+```
+
+## Distribute with CI / CD
+
+Edit pyproject.toml version number and create a release.
+-> Creating a release will trigger the workflow to push the package to PyPi
+
+## Tests
+
+run tests locally:
+
+```bash
+pipenv run test -v
+```
+
+or 
+
+```bash
+pytest
+```
+
+### Generate loose requirements
+
+**Do this in a bash shell using the lowest version you want to support!**
+
+Install uv to easily install all needed python versions (coss-platform)
+
+``` bash
+pip install uv
+```
+
+```bash
+python -m pip install -U pip tox
+```
+
+```bash
+python -m pip install pip-tools
+```
+```bash
+python -m pip install pipreqs
+```
+
+
+To ensure we support multiple python versions we don't want to pin every dependency.
+Instead, we pin everything on the lowest version (that we support) and make
+it loose for every version above.
+
+from root package dir (/gimodules-python)
+
+```bash
+./gen-requirements.sh
+```
+
+#### Ensure python-package version compatibility
+
+```bash
+uv python install 3.10 3.11 3.12 3.13 3.14
+```
+
+Now run for all envs
+
+```bash
+tox
+```
+
+of for a specific version only -> look what you defined in pyproject.toml
+
+```bash
+tox -e py310
+```
+---
+
+**_NOTE:_** Remove the old gimodules version from requirements.txt before pushing (dependency conflict).
+
+---
+
+## Documentation
+
+The documentation is being built as extern script in the GI.Sphinx repository.
+
+The documentation consists of partially generated content. 
+To **generate .rst files** from the code package, run the following command from the root directory of the project:
+
+```bash
+sphinx-apidoc -o docs/source/ src
+```
+You need pandoc installed on the system itself first to build:
+
+```bash
+sudo apt install pandoc
+```
+
+Then, to **build the documentation**, run the following commands:
+
+```bash
+cd docs
+sudo apt update
+pip install -r requirements.txt
+make html
+```
+
+## Linting / Type hints
+
+This project follows the codestyle PEP8 and uses the linter flake8 (with line length = 100).
+
+You can format and check the code using lint.sh:
+    
+```bash
+./lint.sh [directory/]
+```
+
+Type hints are highly recommended.
+Type hints in Python specify the expected data types of variables,
+function arguments, and return values, improving code readability,
+catching errors early, and aiding in IDE autocompletion.
+
+To include type hints in the check:
+
+```bash
+mpypy=true ./lint.sh [directory])
+```

pygidata-0.4.1/README.md

@@ -0,0 +1,183 @@
+# pygidata
+
+# Usage
+
+### Install from PyPi
+
+```bash 
+pip install pygidata
+```
+
+Import module in python script and call functions.
+
+A detailed description of the package and other APIs can be found under [docs/](docs/Usage.ipynb) or in the
+Gantner Documentation.
+
+```python
+from gi_data.dataclient import GIDataClient
+import os
+
+PROFILES = {
+    "qstation": {
+        "base": os.getenv("GI_QSTATION_BASE", "http://10.1.50.36:8090"),
+        "auth": {"username": os.getenv("GI_QSTATION_USER", "admin"),
+                 "password": os.getenv("GI_QSTATION_PASS", "admin")},
+    },
+    "cloud": {
+        "base": os.getenv("GI_CLOUD_BASE", "https://demo.gi-cloud.io"),
+        "auth": {"access_token": os.getenv("GI_CLOUD_TOKEN", "")},
+    },
+}
+
+ACTIVE_PROFILE = os.getenv("GI_PROFILE", "qstation")
+
+def get_client(profile: str = ACTIVE_PROFILE) -> GIDataClient:
+    cfg = PROFILES[profile]
+    if cfg["auth"].get("access_token"):
+        return GIDataClient(cfg["base"], access_token=cfg["auth"]["access_token"]) 
+    return GIDataClient(cfg["base"],
+                        username=cfg["auth"].get("username"),
+                        password=cfg["auth"].get("password"))
+
+client = get_client()
+
+```
+
+
+# Development
+
+### Used as submodule in
+* gi-sphinx
+* gi-jupyterlab
+* gi-analytics-examples
+
+### Information on how to manually distribute this package can be found here
+
+https://packaging.python.org/en/latest/tutorials/packaging-projects/
+
+**Hint:** If you are debugging the source code with a jupyter notebook, run this code in the `first cell` to enable autoreloading source code changes.
+
+```bash
+%load_ext autoreload
+%autoreload 2
+```
+
+## Distribute with CI / CD
+
+Edit pyproject.toml version number and create a release.
+-> Creating a release will trigger the workflow to push the package to PyPi
+
+## Tests
+
+run tests locally:
+
+```bash
+pipenv run test -v
+```
+
+or 
+
+```bash
+pytest
+```
+
+### Generate loose requirements
+
+**Do this in a bash shell using the lowest version you want to support!**
+
+Install uv to easily install all needed python versions (coss-platform)
+
+``` bash
+pip install uv
+```
+
+```bash
+python -m pip install -U pip tox
+```
+
+```bash
+python -m pip install pip-tools
+```
+```bash
+python -m pip install pipreqs
+```
+
+
+To ensure we support multiple python versions we don't want to pin every dependency.
+Instead, we pin everything on the lowest version (that we support) and make
+it loose for every version above.
+
+from root package dir (/gimodules-python)
+
+```bash
+./gen-requirements.sh
+```
+
+#### Ensure python-package version compatibility
+
+```bash
+uv python install 3.10 3.11 3.12 3.13 3.14
+```
+
+Now run for all envs
+
+```bash
+tox
+```
+
+of for a specific version only -> look what you defined in pyproject.toml
+
+```bash
+tox -e py310
+```
+---
+
+**_NOTE:_** Remove the old gimodules version from requirements.txt before pushing (dependency conflict).
+
+---
+
+## Documentation
+
+The documentation is being built as extern script in the GI.Sphinx repository.
+
+The documentation consists of partially generated content. 
+To **generate .rst files** from the code package, run the following command from the root directory of the project:
+
+```bash
+sphinx-apidoc -o docs/source/ src
+```
+You need pandoc installed on the system itself first to build:
+
+```bash
+sudo apt install pandoc
+```
+
+Then, to **build the documentation**, run the following commands:
+
+```bash
+cd docs
+sudo apt update
+pip install -r requirements.txt
+make html
+```
+
+## Linting / Type hints
+
+This project follows the codestyle PEP8 and uses the linter flake8 (with line length = 100).
+
+You can format and check the code using lint.sh:
+    
+```bash
+./lint.sh [directory/]
+```
+
+Type hints are highly recommended.
+Type hints in Python specify the expected data types of variables,
+function arguments, and return values, improving code readability,
+catching errors early, and aiding in IDE autocompletion.
+
+To include type hints in the check:
+
+```bash
+mpypy=true ./lint.sh [directory])
+```

pygidata-0.4.1/pyproject.toml

@@ -0,0 +1,49 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pygidata"
+version = "0.4.1"
+description = "Python package providing an interface to the Gantner Instruments Data API"
+readme = "README.md"
+authors = [{ name = "Gantner Instruments GmbH" }]
+requires-python = ">=3.10,<3.13"
+keywords = ["python"]
+classifiers = [
+  "Development Status :: 1 - Planning",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Operating System :: Unix",
+  "Operating System :: MacOS :: MacOS X",
+  "Operating System :: Microsoft :: Windows"
+]
+dynamic = ["dependencies"]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["gi_data*"]
+
+[tool.setuptools.dynamic]
+dependencies = { file = ["requirements.txt"] }
+
+[project.optional-dependencies]
+test = ["pytest", "pytest-xdist"]
+
+[tool.tox]
+env_list = ["py310", "py311", "py312"]
+
+[tool.tox.env_run_base]
+deps = [
+  "pytest>=7",
+  "pytest-xdist",
+]
+commands = [
+  ["pytest", "-q"]
+]
+package = "wheel"

pygidata-0.4.1/requirements.txt

@@ -0,0 +1,7 @@
+aiokafka
+certifi
+httpx
+nest_asyncio
+pandas
+pydantic
+websockets

pygidata-0.4.1/setup.cfg

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

pygidata-0.4.1/src/gi_data/__init__.py

@@ -0,0 +1,3 @@
+from .dataclient import GIDataClient
+
+__all__: list[str] = ["GIDataClient"]