rovidh 0.1.0__tar.gz

rovidh-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.11"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v8
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --frozen --dev
+
+      - name: Run tests
+        run: uv run --frozen pytest
+
+  docs:
+    name: Docs build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.11"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v8
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --frozen --dev
+
+      - name: Build documentation
+        run: uv run --frozen mkdocs build --strict

rovidh-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,66 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build MkDocs
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.11"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v8
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --frozen --dev
+
+      - name: Configure GitHub Pages
+        uses: actions/configure-pages@v5
+
+      - name: Build documentation
+        run: uv run --frozen mkdocs build --strict
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: site
+
+  deploy:
+    name: Deploy GitHub Pages
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
+
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

rovidh-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,85 @@
+name: Publish PyPI
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.11"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v8
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --frozen --dev
+
+      - name: Run tests
+        run: uv run --frozen pytest
+
+  build:
+    name: Build package
+    needs: tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.11"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v8
+        with:
+          enable-cache: true
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v7
+        with:
+          name: python-distributions
+          path: dist/
+
+  publish:
+    name: Publish package
+    needs: build
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/rovidh
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v7
+        with:
+          name: python-distributions
+          path: dist/
+
+      - name: Publish distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

rovidh-0.1.0/.gitignore

@@ -0,0 +1,223 @@
+# IDE settings
+.idea/
+.vscode/
+o# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+*.lcov
+.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/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

rovidh-0.1.0/LICENSE.md

@@ -0,0 +1,8 @@
+Copyright 2026 ORNL 
+
+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.
+

rovidh-0.1.0/PKG-INFO

@@ -0,0 +1,222 @@
+Metadata-Version: 2.4
+Name: rovidh
+Version: 0.1.0
+Summary: ROVI Data Hub Vendor Agent
+Author-email: "Grant, Josh" <grantjn@ornl.gov>, "Broughton, Mitchell" <broxsonmr@ornl.gov>, "Srikanth, Allu" <allus@ornl.gov>
+License-File: LICENSE.md
+Requires-Python: >=3.11
+Requires-Dist: click>=8.3.1
+Requires-Dist: dotenv>=0.9.9
+Requires-Dist: pydanclick
+Requires-Dist: pydantic-settings>=2.12.0
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: requests-toolbelt>=1.0.0
+Requires-Dist: requests>=2.32.5
+Description-Content-Type: text/markdown
+
+# ROVI Data Hub Vendor CLI
+
+Command-line client for vendor and system operations against the ROVI Data Hub API.
+
+Full documentation is available in the MkDocs source under `docs/`.
+
+The CLI lets you:
+- manage vendor API tokens (admin operations),
+- create/renew/delete system JWTs,
+- upload metadata, files, ONNX models, and Grafana dashboards to ingestion endpoints,
+- inspect active configuration loaded from environment files.
+
+## Requirements
+
+- Python 3.11+
+- `uv` (recommended) or another Python environment manager
+- network access to the ROVI Data Hub API
+
+## Install
+
+### Option 1: with `uv` (recommended)
+
+```bash
+uv sync
+```
+
+Run commands with:
+
+```bash
+uv run rovidh --help
+```
+
+### Option 2: with `pip`
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -e .
+rovidh --help
+```
+
+## Configuration
+
+The app uses environment-based configuration and looks for values in this order (if present):
+- `config/.env.default`
+- `.env.default`
+- `config.env`
+- `.env`
+
+You can also pass values directly via CLI options.
+
+### Common variables
+
+| Variable | Required For | Description |
+|---|---|---|
+| `ROVI_API` | all commands | Base API endpoint (default: `https://rovidatahub.ornl.gov/api`) |
+| `VERIFY_SSL` | all commands | SSL verification toggle (`true`/`false`) |
+| `ADMIN_KEY` | `admin` commands | Admin access token |
+| `VENDOR_NAME` | `admin` commands | Vendor name for token operations |
+| `VENDOR_ID` | `system` commands | Vendor identifier |
+| `VENDOR_KEY` | `system` commands | Vendor key used as `access-token` header |
+| `SYSTEM_NAME` | `system` commands | System name |
+| `SYSTEM_JWT` | `system` + `upload` commands | System JWT bearer token |
+
+Example `.env`:
+
+```dotenv
+ROVI_API=https://rovidatahub.ornl.gov/api
+VERIFY_SSL=true
+
+ADMIN_KEY=...
+VENDOR_NAME=example-vendor
+
+VENDOR_ID=...
+VENDOR_KEY=...
+SYSTEM_NAME=test-system
+SYSTEM_JWT=...
+```
+
+## Command Groups
+
+Top-level help:
+
+```bash
+uv run rovidh --help
+```
+
+### `config`
+
+Show active resolved config:
+
+```bash
+uv run rovidh config show
+```
+
+### `admin`
+
+Create vendor token:
+
+```bash
+uv run rovidh admin new
+```
+
+Delete vendor token:
+
+```bash
+uv run rovidh admin delete
+```
+
+### `system`
+
+Create system JWT (also saves `SYSTEM_NAME`, `VENDOR_ID`, and `SYSTEM_JWT` into `.env`):
+
+```bash
+uv run rovidh system new
+```
+
+Renew current system JWT (updates `SYSTEM_JWT` in `.env`):
+
+```bash
+uv run rovidh system renew
+```
+
+Delete system JWT:
+
+```bash
+uv run rovidh system delete
+```
+
+### `upload`
+
+Upload metadata JSON file:
+
+```bash
+uv run rovidh upload metadata ./metadata.json
+```
+
+Upload single data file:
+
+```bash
+uv run rovidh upload file ./payload.json
+```
+
+Upload ONNX model:
+
+```bash
+uv run rovidh upload model ./model.onnx
+```
+
+Upload Grafana dashboard JSON:
+
+```bash
+uv run rovidh upload dashboard ./dashboard.json
+```
+
+Upload multiple files:
+
+```bash
+uv run rovidh upload files ./a.json ./b.json ./c.json
+```
+
+Upload all files in a directory:
+
+```bash
+uv run rovidh upload directory ./batch
+```
+
+## API Endpoints Used
+
+The CLI calls these API paths relative to `ROVI_API`:
+
+- `POST create_token/{vendor_name}`
+- `POST delete_token/{vendor_name}`
+- `POST create_jwt/{vendor_id}/{system_name}`
+- `POST renew_jwt`
+- `POST delete_jwt/{vendor_id}/{system_name}`
+- `POST upload-metadata/`
+- `POST upload-file/`
+- `POST upload-model/`
+- `POST upload-dashboard/`
+- `POST upload-batch/`
+
+## Development
+
+Install editable dependencies and run commands through `uv`:
+
+```bash
+uv sync
+uv run rovidh --help
+```
+
+Run tests:
+
+```bash
+uv run pytest
+```
+
+Upload tests read `openapi.json` from the repository root when it is present.
+That file is local-only and is not required to be committed; OpenAPI-backed
+tests skip with a clear message if the file is absent.
+
+## Security Notes
+
+- Do not commit `.env` with live credentials.
+- Rotate `ADMIN_KEY`, vendor keys, and JWTs regularly.
+- Keep `VERIFY_SSL=true` except in controlled local testing.