jump2-client 0.1.0__tar.gz

jump2_client-0.1.0/.gitignore

@@ -0,0 +1,250 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+*.tsbuildinfo
+.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
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# 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
+.env.dev
+.envrc
+node/.env.node
+.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/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# DS_Store
+*.DS_Store
+
+# local data
+data/*
+*.swp
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# DS_Store
+.DS_Store
+
+# Database backups
+db-backups/
+
+# Node modules
+node_modules
+
+# debugging
+diff.txt
+
+# VS Code and Zed
+.vscode
+.zed
+
+# Testing
+test-results/
+tests/results/
+playwright-report
+test-data/
+!test-data/kpf-remote/
+
+# Tutorial files
+tutorials/demo_data
+.worktrees/
+
+# Local CLI config (environment-specific, not committed)
+jump2.toml
+
+# nginx
+docker/nginx/.nfs*

jump2_client-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 California Planet Search
+
+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.

jump2_client-0.1.0/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: jump2-client
+Version: 0.1.0
+Summary: Jump 2.0 Python client — standalone, pip-installable, works in JupyterHub or locally.
+Project-URL: Repository, https://github.com/California-Planet-Search/jump2
+Project-URL: Documentation, https://github.com/California-Planet-Search/jump2/blob/main/docs/CLIENT.md
+Author: California Planet Search
+License: MIT
+License-File: LICENSE
+Keywords: api-client,astronomy,jump2,jupyter
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+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.11
+Requires-Dist: pandas>=2.0.0
+Requires-Dist: requests>=2.31.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: sqlglot>=25.0.0
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pandas-stubs; extra == 'dev'
+Requires-Dist: pytest-mock>=3.14.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: types-requests; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest-mock>=3.14.0; extra == 'test'
+Requires-Dist: pytest>=8.0.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# jump2-client
+
+Standalone Python client for the [Jump 2.0](https://github.com/keck-community/jump2) astronomical data portal.
+
+Works in **JupyterHub** (zero-config — credentials injected at spawn) or **locally** with an API key.
+
+## Install
+
+```bash
+pip install jump2-client
+# or, from source:
+cd client && uv sync
+```
+
+Requirements: Python ≥ 3.11, `requests`, `sqlglot ≥ 25.0`.
+
+## Quick start
+
+```python
+from jump2_client import Client
+
+# In JupyterHub — no setup needed:
+c = Client()
+c.status()    # connectivity + ACL check
+c.discover()  # browse the API endpoint catalogue
+c.docs        # print cheat-sheet
+
+# Locally:
+c = Client(base_url="https://jump2.example.org", api_key="jump2_live_…")
+```
+
+## Data access
+
+```python
+# Raw SQL → DataFrame (RLS enforced server-side):
+df = c.data.query("SELECT url_slug, vmag FROM core_star ORDER BY vmag LIMIT 20")
+
+# Fluent query builder:
+df = (c.data.table("core_star")
+        .select("url_slug", "vmag", "ra", "dec")
+        .where(vmag__lt=8)
+        .order_by("vmag")
+        .limit(25)
+        .df())
+
+# Stars and observations:
+for star in c.data.stars():
+    print(star["url_slug"])
+```
+
+## Error handling
+
+```python
+from jump2_client import AuthError, ValidationError, NotFoundError
+
+try:
+    df = c.data.query("SELECT * FROM bad_table")
+except ValidationError as e:
+    print(e.detail)  # server message
+    print(e.hint)    # remediation hint
+```
+
+## Full documentation
+
+See [`docs/CLIENT.md`](../docs/CLIENT.md) in the jump2 repository for the complete reference:
+authentication modes, URL prefix convention, QueryBuilder operators, admin API, error model,
+and key regeneration flow.

jump2_client-0.1.0/README.md

@@ -0,0 +1,67 @@
+# jump2-client
+
+Standalone Python client for the [Jump 2.0](https://github.com/keck-community/jump2) astronomical data portal.
+
+Works in **JupyterHub** (zero-config — credentials injected at spawn) or **locally** with an API key.
+
+## Install
+
+```bash
+pip install jump2-client
+# or, from source:
+cd client && uv sync
+```
+
+Requirements: Python ≥ 3.11, `requests`, `sqlglot ≥ 25.0`.
+
+## Quick start
+
+```python
+from jump2_client import Client
+
+# In JupyterHub — no setup needed:
+c = Client()
+c.status()    # connectivity + ACL check
+c.discover()  # browse the API endpoint catalogue
+c.docs        # print cheat-sheet
+
+# Locally:
+c = Client(base_url="https://jump2.example.org", api_key="jump2_live_…")
+```
+
+## Data access
+
+```python
+# Raw SQL → DataFrame (RLS enforced server-side):
+df = c.data.query("SELECT url_slug, vmag FROM core_star ORDER BY vmag LIMIT 20")
+
+# Fluent query builder:
+df = (c.data.table("core_star")
+        .select("url_slug", "vmag", "ra", "dec")
+        .where(vmag__lt=8)
+        .order_by("vmag")
+        .limit(25)
+        .df())
+
+# Stars and observations:
+for star in c.data.stars():
+    print(star["url_slug"])
+```
+
+## Error handling
+
+```python
+from jump2_client import AuthError, ValidationError, NotFoundError
+
+try:
+    df = c.data.query("SELECT * FROM bad_table")
+except ValidationError as e:
+    print(e.detail)  # server message
+    print(e.hint)    # remediation hint
+```
+
+## Full documentation
+
+See [`docs/CLIENT.md`](../docs/CLIENT.md) in the jump2 repository for the complete reference:
+authentication modes, URL prefix convention, QueryBuilder operators, admin API, error model,
+and key regeneration flow.

jump2_client-0.1.0/jump2_client/__init__.py

@@ -0,0 +1,49 @@
+"""
+jump2_client — Jump 2.0 Python client.
+
+Lightweight, standalone, pip-installable.  Works in JupyterHub (picks up
+credentials from the environment automatically) or locally (provide
+``base_url`` and ``api_key``, or use :meth:`~jump2_client.client.Client.login`).
+
+Quick start::
+
+    from jump2_client import Client
+
+    # In JupyterHub — zero config needed, credentials injected at spawn:
+    c = Client()
+    c.status()                               # connectivity + ACL check
+    c.discover()                             # browse the API
+
+    # Locally:
+    c = Client(base_url="https://jump2.example.org", api_key="...")
+    # or:
+    c = Client(base_url="https://jump2.example.org").login("user", "pass")
+
+    # Data access (RLS invisible — server handles authorisation):
+    df = c.data.query("SELECT url_slug, vmag FROM core_star LIMIT 20")
+    files = c.data.files("hd-209458")
+
+    # Jobs:
+    result = c.jobs.poll(42)
+
+    # Admin (requires elevated permissions):
+    job = c.admin.ingest.launch(instruments=["apf"])
+    c.admin.schedules.list()
+"""
+
+from .client import Client
+from .errors import AuthError, Jump2Error, NotFoundError, ServerError, ValidationError
+from .query import QueryBuilder
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "Client",
+    "Jump2Error",
+    "AuthError",
+    "NotFoundError",
+    "ServerError",
+    "ValidationError",
+    "QueryBuilder",
+    "__version__",
+]

jump2_client-0.1.0/jump2_client/_pretty.py

@@ -0,0 +1,44 @@
+"""
+jump2_client._pretty — rich rendering helpers.
+
+Kept in a private module so the public API stays clean.  The ``rich``
+library is always available (it is a declared dependency), but callers
+never need to import it themselves — just call the public methods on the
+client objects and they print formatted tables automatically.
+"""
+from __future__ import annotations
+
+from typing import Any
+
+
+def _rich() -> Any:
+    """Lazy import of rich.console.Console to avoid import-time overhead."""
+    from rich.console import Console
+    return Console()
+
+
+def print_table(title: str, columns: list[str], rows: list[list[Any]]) -> None:
+    """Print a labelled rich table to stdout."""
+    from rich.table import Table
+
+    console = _rich()
+    table = Table(title=title, show_header=True, header_style="bold cyan")
+    for col in columns:
+        table.add_column(col, overflow="fold")
+    for row in rows:
+        table.add_row(*[str(v) if v is not None else "" for v in row])
+    console.print(table)
+
+
+def print_dict(title: str, data: dict[str, Any]) -> None:
+    """Print a two-column key/value rich table."""
+    print_table(title, ["Key", "Value"], [[k, v] for k, v in data.items()])
+
+
+def format_bytes(n: int | float) -> str:
+    """Human-readable byte size (e.g. ``"3.2 GiB"``)."""
+    for unit in ("B", "KiB", "MiB", "GiB", "TiB"):
+        if abs(n) < 1024.0:
+            return f"{n:.1f} {unit}"
+        n /= 1024.0
+    return f"{n:.1f} PiB"

jump2_client-0.1.0/jump2_client/admin/__init__.py

@@ -0,0 +1,57 @@
+"""
+jump2_client.admin — admin-only operations.
+
+All actions in this submodule require elevated permissions (``run_jobs``,
+``manage_schedules``, ``manage_users`` etc.).  Authorisation is enforced
+server-side — calling these without the required tokens raises
+:exc:`~jump2_client.errors.AuthError`.
+
+Submodules
+----------
+``ingest``
+    Preview and launch ad-hoc ingest coordinator jobs.
+
+``schedules``
+    CRUD for Celery-Beat ingest schedules.
+
+``users``
+    Admin user and resource-usage views.
+
+Example::
+
+    from jump2_client import Client
+    c = Client()
+
+    # Preview what would be ingested
+    preview = c.admin.ingest.preview()
+
+    # Launch a manual ingest
+    job = c.admin.ingest.launch()
+    result = c.jobs.poll(job["id"])
+
+    # Manage schedules
+    c.admin.schedules.list()
+"""
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from .ingest import AdminIngest
+from .schedules import AdminSchedules
+from .users import AdminUsers
+
+if TYPE_CHECKING:
+    from ..session import Session
+
+
+class Admin:
+    """
+    Admin-only client namespace.
+
+    Attached to :class:`~jump2_client.client.Client` as ``client.admin``.
+    """
+
+    def __init__(self, session: Session) -> None:
+        self.ingest = AdminIngest(session)
+        self.schedules = AdminSchedules(session)
+        self.users = AdminUsers(session)