gpp-client 25.5.0a0__tar.gz

gpp_client-25.5.0a0/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2025 Association of Universities for Research in Astronomy, Inc. (AURA)
+All rights reserved.
+
+Unless otherwise stated, the copyright of this software is owned by AURA.
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1) Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+2) Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+3) The names of AURA and its representatives may not be used to endorse or
+  promote products derived from this software without specific prior written
+  permission.
+
+THIS SOFTWARE IS PROVIDED BY AURA "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL AURA BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

gpp_client-25.5.0a0/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.4
+Name: gpp-client
+Version: 25.5.0a0
+Summary: Gemini Program Platform client.
+Author: NOIRLab
+License: Copyright (c) 2025 Association of Universities for Research in Astronomy, Inc. (AURA)
+        All rights reserved.
+        
+        Unless otherwise stated, the copyright of this software is owned by AURA.
+        Redistribution and use in source and binary forms, with or without modification,
+        are permitted provided that the following conditions are met:
+        
+        1) Redistributions of source code must retain the above copyright notice,
+          this list of conditions and the following disclaimer.
+        2) Redistributions in binary form must reproduce the above copyright notice,
+          this list of conditions and the following disclaimer in the documentation
+          and/or other materials provided with the distribution.
+        3) The names of AURA and its representatives may not be used to endorse or
+          promote products derived from this software without specific prior written
+          permission.
+        
+        THIS SOFTWARE IS PROVIDED BY AURA "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+        INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+        FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL AURA BE
+        LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+        CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+        GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+        HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+        LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+        THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Project-URL: Homepage, https://github.com/gemini-hlsw/gpp-client
+Project-URL: Source, https://github.com/gemini-hlsw/gpp-client
+Project-URL: Issues, https://github.com/gemini-hlsw/gpp-client/issues
+Project-URL: Documentation, https://gpp-client.readthedocs.io/en/latest/
+Keywords: gemini,gpp,client,program,platform
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Requires-Python: >=3.10.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: toml>=0.10.2
+Requires-Dist: typer>=0.15.3
+Requires-Dist: ariadne-codegen[subscriptions]>=0.14.0
+Requires-Dist: click<8.2.0,>=8.0.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-xdist; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+Requires-Dist: pytest-remotedata; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
+Requires-Dist: ruff; extra == "test"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: sphinx-autobuild; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: sphinxcontrib-typer; extra == "docs"
+Dynamic: license-file
+
+# GPP Client
+
+[![Run Tests](https://github.com/gemini-hlsw/gpp-client/actions/workflows/run_tests.yaml/badge.svg?branch=main)](https://github.com/gemini-hlsw/gpp-client/actions/workflows/run_tests.yaml)
+![Docs Status](https://readthedocs.org/projects/gpp-client/badge/?version=latest)
+
+---
+
+_Pain-free python/CLI communication with the Gemini Program Platform (GPP)._
+
+**Documentation**: <a href="https://gpp-client.readthedocs.io/en/latest/" target="_blank">https://gpp-client.readthedocs.io/en/latest/</a>
+
+**Source Code**: <a href="https://github.com/gemini-hlsw/gpp-client" target="_blank">https://github.com/gemini-hlsw/gpp-client</a>
+
+---
+
+Python client and CLI for the GPP. Key features:
+
+- **Type‑safe GraphQL**
+  - Pydantic models from the GPP GraphQL schema, so every query, mutation, and input type is validated.
+- **Resource Managers**
+  - High‑level `Manager` classes (e.g. `GPPClient.program`, `GPPClient.observation`) with convenient `get_by_id`, `get_all`, `create`, `update_by_id`, `delete_by_id`, `restore_by_id` and more methods, no need to write raw GraphQL.
+- **Flexible payloads**
+  - Create or update via in‑memory Pydantic inputs **or** `from_json` files.
+- **`gpp` CLI**
+  - Full CRUD surface on the command line: `gpp <resource> list|get|create|update|delete`, with rich table output and JSON export options.
+
+### Requirements
+
+- `python>=3.10`
+- `toml`
+- `typer`
+- `ariadne-codegen`
+
+## Development Status
+
+🚧 Alpha: the library is under heavy development. The public API and CLI flags may change between releases.
+
+## Installation
+
+```bash
+pip install gpp-client
+```
+
+## Quickstart
+
+```python
+from gpp_client import GPPClient
+
+# Initialize with your GraphQL endpoint and credentials.
+client = GPPClient(url="YOUR_URL", token="YOUR_TOKEN")
+
+# List the first 5 program notes.
+notes = await client.program_note.get_all(limit=5)
+for note in notes["matches"]:
+    print(f"{note['id']}: {note['title']}")
+
+# Create a new note from a JSON file.
+new_note = await client.program_note.create(
+    from_json="path/to/program_note_payload.json",
+    program_id="p-123"
+)
+print("Created:", new_note)
+
+# Or create a note from the pydantic model.
+from gpp_client.api.enums import Existence
+from gpp_client.api.input_types import ProgramNotePropertiesInput
+
+properties = ProgramNotePropertiesInput(
+    title="Example",
+    text="This is an example.",
+    is_private=False,
+    existence=Existence.PRESENT
+)
+another_note = await client.program_note.create(properties=properties, program_id="p-123")
+
+print("Created another:", another_note)
+```
+
+## As a CLI
+
+```bash
+# Get help.
+gpp --help
+
+# Get observation help.
+gpp obs --help
+
+# List observations.
+gpp obs list --limit 3
+
+# Get details for one.
+gpp obs get o-123
+
+# Create via JSON.
+gpp obs create --from-json new_obs.json --program-id p-123
+
+# Update by ID via JSON.
+gpp obs update --observation-id o-123 --from-json updated_obs.json
+```
+
+## Reporting Bugs and Feature Requests
+
+**Jira**: https://noirlab.atlassian.net/jira/software/projects/GPC/boards/162
+
+**NOIRLab Slack channel**: `#gpp-client`
+
+While in heavy development, please file requests or report bugs via our Jira board or Slack channel.
+

gpp_client-25.5.0a0/README.md

@@ -0,0 +1,108 @@
+# GPP Client
+
+[![Run Tests](https://github.com/gemini-hlsw/gpp-client/actions/workflows/run_tests.yaml/badge.svg?branch=main)](https://github.com/gemini-hlsw/gpp-client/actions/workflows/run_tests.yaml)
+![Docs Status](https://readthedocs.org/projects/gpp-client/badge/?version=latest)
+
+---
+
+_Pain-free python/CLI communication with the Gemini Program Platform (GPP)._
+
+**Documentation**: <a href="https://gpp-client.readthedocs.io/en/latest/" target="_blank">https://gpp-client.readthedocs.io/en/latest/</a>
+
+**Source Code**: <a href="https://github.com/gemini-hlsw/gpp-client" target="_blank">https://github.com/gemini-hlsw/gpp-client</a>
+
+---
+
+Python client and CLI for the GPP. Key features:
+
+- **Type‑safe GraphQL**
+  - Pydantic models from the GPP GraphQL schema, so every query, mutation, and input type is validated.
+- **Resource Managers**
+  - High‑level `Manager` classes (e.g. `GPPClient.program`, `GPPClient.observation`) with convenient `get_by_id`, `get_all`, `create`, `update_by_id`, `delete_by_id`, `restore_by_id` and more methods, no need to write raw GraphQL.
+- **Flexible payloads**
+  - Create or update via in‑memory Pydantic inputs **or** `from_json` files.
+- **`gpp` CLI**
+  - Full CRUD surface on the command line: `gpp <resource> list|get|create|update|delete`, with rich table output and JSON export options.
+
+### Requirements
+
+- `python>=3.10`
+- `toml`
+- `typer`
+- `ariadne-codegen`
+
+## Development Status
+
+🚧 Alpha: the library is under heavy development. The public API and CLI flags may change between releases.
+
+## Installation
+
+```bash
+pip install gpp-client
+```
+
+## Quickstart
+
+```python
+from gpp_client import GPPClient
+
+# Initialize with your GraphQL endpoint and credentials.
+client = GPPClient(url="YOUR_URL", token="YOUR_TOKEN")
+
+# List the first 5 program notes.
+notes = await client.program_note.get_all(limit=5)
+for note in notes["matches"]:
+    print(f"{note['id']}: {note['title']}")
+
+# Create a new note from a JSON file.
+new_note = await client.program_note.create(
+    from_json="path/to/program_note_payload.json",
+    program_id="p-123"
+)
+print("Created:", new_note)
+
+# Or create a note from the pydantic model.
+from gpp_client.api.enums import Existence
+from gpp_client.api.input_types import ProgramNotePropertiesInput
+
+properties = ProgramNotePropertiesInput(
+    title="Example",
+    text="This is an example.",
+    is_private=False,
+    existence=Existence.PRESENT
+)
+another_note = await client.program_note.create(properties=properties, program_id="p-123")
+
+print("Created another:", another_note)
+```
+
+## As a CLI
+
+```bash
+# Get help.
+gpp --help
+
+# Get observation help.
+gpp obs --help
+
+# List observations.
+gpp obs list --limit 3
+
+# Get details for one.
+gpp obs get o-123
+
+# Create via JSON.
+gpp obs create --from-json new_obs.json --program-id p-123
+
+# Update by ID via JSON.
+gpp obs update --observation-id o-123 --from-json updated_obs.json
+```
+
+## Reporting Bugs and Feature Requests
+
+**Jira**: https://noirlab.atlassian.net/jira/software/projects/GPC/boards/162
+
+**NOIRLab Slack channel**: `#gpp-client`
+
+While in heavy development, please file requests or report bugs via our Jira board or Slack channel.
+

gpp_client-25.5.0a0/pyproject.toml

@@ -0,0 +1,91 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "gpp-client"
+description = "Gemini Program Platform client."
+readme = "README.md"
+authors = [{ name = "NOIRLab" }]
+license = { file = "LICENSE" }
+requires-python = ">=3.10.0"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: Astronomy",
+]
+dependencies = [
+    "toml>=0.10.2",
+    "typer>=0.15.3",
+    "ariadne-codegen[subscriptions]>=0.14.0",
+    "click>=8.0.0,<8.2.0",
+]
+version = "25.05.0a0"
+keywords = ["gemini", "gpp", "client", "program", "platform"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+    "pytest-xdist",
+    "pytest-cov",
+    "pytest-asyncio",
+    "pytest-remotedata",
+    "pytest-mock",
+    "ruff",
+]
+docs = [
+    "sphinx",
+    "sphinx-rtd-theme",
+    "sphinx-autobuild",
+    "furo",
+    "sphinxcontrib-typer",
+]
+
+[project.scripts]
+gpp = "gpp_client.cli.cli:main"
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+docstring-code-format = true
+docstring-code-line-length = "dynamic"
+
+[tool.ruff]
+# Ignore generated code.
+extend-exclude = ["api"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+# addopts = "-r A -v -n auto --cov=src --cov-report=term --cov=tests --cov-branch"
+addopts = ["--import-mode=importlib", "-rs"]
+asyncio_default_fixture_loop_scope = "session"
+
+[tool.ariadne-codegen]
+schema_path = "schema.graphql"
+client_name = "_GPPClient"
+client_file_name = "_client"
+enable_custom_operations = true
+target_package_name = "api"
+target_package_path = "src/gpp_client"
+convert_to_snake_case = true
+plugins = [
+    "custom_plugins.AliasStrWrapperPlugin",
+    "custom_plugins.FixCustomFieldsLiteralPlugin",
+]
+
+[project.urls]
+Homepage = "https://github.com/gemini-hlsw/gpp-client"
+Source = "https://github.com/gemini-hlsw/gpp-client"
+Issues = "https://github.com/gemini-hlsw/gpp-client/issues"
+Documentation = "https://gpp-client.readthedocs.io/en/latest/"

gpp_client-25.5.0a0/setup.cfg

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

gpp_client-25.5.0a0/src/custom_plugins/__init__.py

@@ -0,0 +1,4 @@
+from .alias_str_wrapper import AliasStrWrapperPlugin
+from .fix_custom_fields_literal import FixCustomFieldsLiteralPlugin
+
+__all__ = ["AliasStrWrapperPlugin", "FixCustomFieldsLiteralPlugin"]

gpp_client-25.5.0a0/src/custom_plugins/alias_str_wrapper.py

@@ -0,0 +1,31 @@
+__all__ = ["AliasStrWrapperPlugin"]
+
+import ast
+
+from ariadne_codegen.plugins.base import Plugin
+from graphql import (
+    GraphQLInputField,
+)
+
+
+class AliasStrWrapperPlugin(Plugin):
+    def generate_input_field(
+        self,
+        field_implementation: ast.AnnAssign,
+        input_field: GraphQLInputField,
+        field_name: str,
+    ) -> ast.AnnAssign:
+        """Wraps alias value in str() for VSCode/Pyright compatibility.
+        Changes: alias="fooBar" to alias=str("fooBar")
+        """
+        # Check if the field has a keyword with alias=
+        if isinstance(field_implementation.value, ast.Call):
+            for keyword in field_implementation.value.keywords:
+                if keyword.arg == "alias" and isinstance(keyword.value, ast.Constant):
+                    # Wrap alias value in str()
+                    keyword.value = ast.Call(
+                        func=ast.Name(id="str", ctx=ast.Load()),
+                        args=[keyword.value],
+                        keywords=[],
+                    )
+        return field_implementation

gpp_client-25.5.0a0/src/custom_plugins/fix_custom_fields_literal.py

@@ -0,0 +1,107 @@
+__all__ = ["FixCustomFieldsLiteralPlugin"]
+
+import ast
+from typing import Any, Dict, List, Optional, cast
+
+from ariadne_codegen.client_generators import custom_fields as _cf
+from ariadne_codegen.plugins.base import Plugin
+
+
+class FixCustomFieldsLiteralPlugin(Plugin):
+    """Patch CustomFieldsGenerator so GraphQL literals keep camelCase.
+
+    References
+    ----------
+    .. [1] *ariadne-codegen* source file:
+           https://github.com/mirumee/ariadne-codegen/blob/main/ariadne_codegen/client_generators/custom_fields.py
+    .. [2] Pull request that introduces the fix:
+           https://github.com/mirumee/ariadne-codegen/pull/326
+    """
+
+    def __init__(self, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+
+        self._patch__generate_class_field()
+        self._patch_generate_product_type_method()
+
+    @staticmethod
+    def _patch__generate_class_field() -> None:
+        original = _cf.CustomFieldsGenerator._generate_class_field
+
+        def patched(
+            self,
+            name: str,
+            field_name: str,
+            org_name: str,
+            field: ast.ClassDef,
+            method_required: bool,
+            lineno: int,
+        ):
+            """Handles the generation of field types."""
+            if getattr(field, "args") or method_required:
+                return self.generate_product_type_method(
+                    name, org_name, field_name, getattr(field, "args")
+                )
+            # Fallback to original behaviour (scalar fields, no args).
+            return original(
+                self,
+                name,
+                field_name,
+                org_name,
+                field,
+                method_required,
+                lineno,
+            )
+
+        _cf.CustomFieldsGenerator._generate_class_field = patched  # type: ignore[attr-defined]
+
+    @staticmethod
+    def _patch_generate_product_type_method() -> None:
+        def patched(
+            self: _cf.CustomFieldsGenerator,
+            name: str,
+            org_name: str,
+            class_name: str,
+            arguments: Optional[Dict[str, Any]] = None,
+        ):
+            """Generates a method for a product type."""
+            arguments = arguments or {}
+            field_class_name = _cf.generate_name(class_name)
+            (
+                method_arguments,
+                return_arguments_keys,
+                return_arguments_values,
+            ) = self.argument_generator.generate_arguments(arguments)
+            self._imports.extend(self.argument_generator.imports)
+            arguments_body: List[ast.stmt] = []
+            arguments_keyword: List[ast.keyword] = []
+
+            if arguments:
+                (
+                    arguments_body,
+                    arguments_keyword,
+                ) = self.argument_generator.generate_clear_arguments_section(
+                    return_arguments_keys, return_arguments_values
+                )
+
+            return _cf.generate_method_definition(
+                name,
+                arguments=method_arguments,
+                body=cast(
+                    List[ast.stmt],
+                    [
+                        *arguments_body,
+                        _cf.generate_return(
+                            value=_cf.generate_call(
+                                func=field_class_name,
+                                args=[_cf.generate_constant(org_name)],
+                                keywords=arguments_keyword,
+                            )
+                        ),
+                    ],
+                ),
+                return_type=_cf.generate_name(f'"{class_name}"'),
+                decorator_list=[_cf.generate_name("classmethod")],
+            )
+
+        _cf.CustomFieldsGenerator.generate_product_type_method = patched  # type: ignore[attr-defined]

gpp_client-25.5.0a0/src/gpp_client/__init__.py

@@ -0,0 +1,3 @@
+from .client import GPPClient
+
+__all__ = ["GPPClient"]