openobserve-cli 0.1.0__tar.gz

openobserve_cli-0.1.0/.github/workflows/publish.yaml

@@ -0,0 +1,36 @@
+name: Publish
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+
+jobs:
+  publish:
+    name: Release to GitHub and PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write   # the GitHub release
+      id-token: write   # PyPI trusted publishing, so there is no token to store
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.13"
+
+      - name: Build Package
+        run: uv build
+
+      - name: Publish Release Notes
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            ./dist/*.whl
+            ./dist/*.tar.gz
+          generate_release_notes: true
+
+      - name: Publish Distribution Package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

openobserve_cli-0.1.0/.github/workflows/test.yaml

@@ -0,0 +1,45 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+
+  lint:
+    name: Run pre-commit hooks
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - run: python -m pip install pre-commit
+
+      - run: pre-commit run -a --show-diff-on-failure
+
+  test:
+    name: Run Unit Tests
+    needs: [lint]
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - run: uv sync
+
+      - run: uv run pytest

openobserve_cli-0.1.0/.gitignore

@@ -0,0 +1,7 @@
+__pycache__/
+*.py[cod]
+.venv/
+dist/
+build/
+*.egg-info/
+.pytest_cache/

openobserve_cli-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+default_install_hook_types:
+  - pre-commit
+  - commit-msg
+
+default_stages:
+  - pre-commit
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+        args: ["--allow-multiple-documents"]  # the deploy manifest is a bundle
+      - id: check-toml
+      - id: detect-private-key
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.3
+    hooks:
+      - id: ruff-format
+      - id: ruff-check
+        args: ["--fix", "--exit-non-zero-on-fix", "--config", "pyproject.toml"]
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.18.2
+    hooks:
+      - id: mypy
+        args: ["--ignore-missing-imports"]
+        additional_dependencies:
+          - httpx
+          - pytest
+
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v4.3.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]

openobserve_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Skip Pay s.r.o.
+
+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.

openobserve_cli-0.1.0/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.5
+Name: openobserve-cli
+Version: 0.1.0
+Summary: CLI for the OpenObserve HTTP API
+Project-URL: Homepage, https://github.com/paveldedik/oo-cli
+Project-URL: Repository, https://github.com/paveldedik/oo-cli
+Project-URL: Issues, https://github.com/paveldedik/oo-cli/issues
+Author-email: Pavel Dedík <dedikx@gmail.com>
+Maintainer-email: Pavel Dedík <dedikx@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cli,logs,metrics,observability,openobserve,traces
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27
+Description-Content-Type: text/markdown
+
+# oo
+
+A small CLI for the OpenObserve HTTP API. Commands are a transcription of the API rather
+than a model of it: `oo get dashboards` is `GET /api/{org}/dashboards`, and anything the
+CLI does not know about is still reachable with `oo api`.
+
+```bash
+oo get dashboards
+oo get alerts --folder default           # GET /api/v2/{org}/alerts?folder=default
+oo get streams/app_logs
+oo post alerts -f alert.json
+oo put dashboards/0194f0e1 -d @- < dashboard.json
+oo delete alerts/7
+
+oo search --sql "select * from default limit 10" --from -30m
+oo api GET /api/default/prometheus/api/v1/query --query "up"
+```
+
+Any `--name value` or `--name=value` the CLI does not define becomes a query parameter.
+`-d` takes a literal body, `@file` or `@-` for stdin; `-f file` is shorthand for `-d @file`.
+Output is pretty-printed JSON on stdout, errors on stderr, exit code 1 on HTTP >= 400 and
+2 on a bad command.
+
+Times accept `now`, an offset (`-15m`, `-2h`, `-7d`), an epoch timestamp in seconds,
+milliseconds or microseconds, or an ISO 8601 datetime (local time when it carries no zone).
+
+## Install
+
+```bash
+uv tool install openobserve-cli     # installs the `oo` command
+uvx openobserve-cli get streams     # or run it without installing anything
+```
+
+The command is `oo`; `openobserve-cli` is the same command under the distribution's
+name, which is what makes the `uvx` one-liner work. From a checkout: `uv sync` and
+then `uv run oo --help`.
+
+## Configuration
+
+Everything comes from the environment. Nothing is required: with no variables set the
+CLI talks to `http://localhost:5080` as an anonymous user, which is what a port-forward
+to a local OpenObserve looks like.
+
+| Variable                  | Required                        | Default                 | Meaning                                       |
+|---------------------------|---------------------------------|-------------------------|-----------------------------------------------|
+| `OO_ENDPOINT`             | optional                        | `http://localhost:5080` | base URL                                      |
+| `OO_ORG`                  | optional                        | `default`               | organization                                  |
+| `OO_TOKEN`                | to reach anything but `/healthz`| —                       | base64 of `email:token`, sent as basic auth   |
+| `OO_USER` / `OO_PASSWORD` | instead of `OO_TOKEN`           | —                       | the same credential spelled out               |
+| `OO_COOKIE`               | when a gateway guards the host  | —                       | `Cookie` header, sent verbatim                |
+| `OO_TIMEOUT`              | optional                        | `60`                    | request timeout in seconds                    |
+
+`--endpoint`, `--org` and `--timeout` override the corresponding variable.
+
+## When something authenticates in front of OpenObserve
+
+Plenty of deployments put OpenObserve behind a gateway that authenticates users itself:
+an AWS ALB with an `authenticate-oidc` action, oauth2-proxy, an identity-aware proxy.
+Such a gateway takes nothing but its own session cookie, which it issues to a browser
+at the end of an interactive login — no API token gets past it, and a CLI cannot run
+that flow on its own.
+
+So hand it the cookie your browser already has. In devtools, Network tab, take the
+`Cookie` header off any request to that host (or Application, Cookies) and:
+
+```bash
+export OO_COOKIE="AWSELBAuthSessionCookie-0=...; AWSELBAuthSessionCookie-1=..."
+```
+
+It is sent verbatim, so any gateway's cookie works, whatever it calls it. A request
+that hits the gateway without one says so instead of failing on a page of HTML. The
+cookie expires on the gateway's schedule — an ALB session lasts 7 days by default.
+
+The gateway is orthogonal to OpenObserve's own authentication: the cookie gets you
+through the door, `OO_TOKEN` still identifies you to OpenObserve.
+
+## v1 and v2
+
+Where an endpoint exists in both versions, v2 is used; there is no version switch. The CLI
+reads the instance's own OpenAPI document (`/api-doc/openapi.json`) to decide, so it follows
+whatever is deployed. The document is cached per endpoint under `~/.cache/oo-cli` for a week.
+
+```bash
+oo spec paths alerts     # list endpoints and their methods
+oo spec refresh          # refetch after an OpenObserve upgrade
+```
+
+Without a reachable spec the CLI falls back to v1, except for `alerts`, `folders` and
+`reports`, the three resources that have a v2 in OpenObserve 0.91.
+
+## Development
+
+```bash
+uv sync
+uv run pytest
+pre-commit install     # ruff, mypy and conventional commit messages
+```

openobserve_cli-0.1.0/README.md

@@ -0,0 +1,97 @@
+# oo
+
+A small CLI for the OpenObserve HTTP API. Commands are a transcription of the API rather
+than a model of it: `oo get dashboards` is `GET /api/{org}/dashboards`, and anything the
+CLI does not know about is still reachable with `oo api`.
+
+```bash
+oo get dashboards
+oo get alerts --folder default           # GET /api/v2/{org}/alerts?folder=default
+oo get streams/app_logs
+oo post alerts -f alert.json
+oo put dashboards/0194f0e1 -d @- < dashboard.json
+oo delete alerts/7
+
+oo search --sql "select * from default limit 10" --from -30m
+oo api GET /api/default/prometheus/api/v1/query --query "up"
+```
+
+Any `--name value` or `--name=value` the CLI does not define becomes a query parameter.
+`-d` takes a literal body, `@file` or `@-` for stdin; `-f file` is shorthand for `-d @file`.
+Output is pretty-printed JSON on stdout, errors on stderr, exit code 1 on HTTP >= 400 and
+2 on a bad command.
+
+Times accept `now`, an offset (`-15m`, `-2h`, `-7d`), an epoch timestamp in seconds,
+milliseconds or microseconds, or an ISO 8601 datetime (local time when it carries no zone).
+
+## Install
+
+```bash
+uv tool install openobserve-cli     # installs the `oo` command
+uvx openobserve-cli get streams     # or run it without installing anything
+```
+
+The command is `oo`; `openobserve-cli` is the same command under the distribution's
+name, which is what makes the `uvx` one-liner work. From a checkout: `uv sync` and
+then `uv run oo --help`.
+
+## Configuration
+
+Everything comes from the environment. Nothing is required: with no variables set the
+CLI talks to `http://localhost:5080` as an anonymous user, which is what a port-forward
+to a local OpenObserve looks like.
+
+| Variable                  | Required                        | Default                 | Meaning                                       |
+|---------------------------|---------------------------------|-------------------------|-----------------------------------------------|
+| `OO_ENDPOINT`             | optional                        | `http://localhost:5080` | base URL                                      |
+| `OO_ORG`                  | optional                        | `default`               | organization                                  |
+| `OO_TOKEN`                | to reach anything but `/healthz`| —                       | base64 of `email:token`, sent as basic auth   |
+| `OO_USER` / `OO_PASSWORD` | instead of `OO_TOKEN`           | —                       | the same credential spelled out               |
+| `OO_COOKIE`               | when a gateway guards the host  | —                       | `Cookie` header, sent verbatim                |
+| `OO_TIMEOUT`              | optional                        | `60`                    | request timeout in seconds                    |
+
+`--endpoint`, `--org` and `--timeout` override the corresponding variable.
+
+## When something authenticates in front of OpenObserve
+
+Plenty of deployments put OpenObserve behind a gateway that authenticates users itself:
+an AWS ALB with an `authenticate-oidc` action, oauth2-proxy, an identity-aware proxy.
+Such a gateway takes nothing but its own session cookie, which it issues to a browser
+at the end of an interactive login — no API token gets past it, and a CLI cannot run
+that flow on its own.
+
+So hand it the cookie your browser already has. In devtools, Network tab, take the
+`Cookie` header off any request to that host (or Application, Cookies) and:
+
+```bash
+export OO_COOKIE="AWSELBAuthSessionCookie-0=...; AWSELBAuthSessionCookie-1=..."
+```
+
+It is sent verbatim, so any gateway's cookie works, whatever it calls it. A request
+that hits the gateway without one says so instead of failing on a page of HTML. The
+cookie expires on the gateway's schedule — an ALB session lasts 7 days by default.
+
+The gateway is orthogonal to OpenObserve's own authentication: the cookie gets you
+through the door, `OO_TOKEN` still identifies you to OpenObserve.
+
+## v1 and v2
+
+Where an endpoint exists in both versions, v2 is used; there is no version switch. The CLI
+reads the instance's own OpenAPI document (`/api-doc/openapi.json`) to decide, so it follows
+whatever is deployed. The document is cached per endpoint under `~/.cache/oo-cli` for a week.
+
+```bash
+oo spec paths alerts     # list endpoints and their methods
+oo spec refresh          # refetch after an OpenObserve upgrade
+```
+
+Without a reachable spec the CLI falls back to v1, except for `alerts`, `folders` and
+`reports`, the three resources that have a v2 in OpenObserve 0.91.
+
+## Development
+
+```bash
+uv sync
+uv run pytest
+pre-commit install     # ruff, mypy and conventional commit messages
+```

openobserve_cli-0.1.0/pyproject.toml

@@ -0,0 +1,78 @@
+[project]
+# "oo", "oo-cli" and "openobserve" are all taken on PyPI.
+name = "openobserve-cli"
+version = "0.1.0"
+description = "CLI for the OpenObserve HTTP API"
+readme = "README.md"
+keywords = ["openobserve", "observability", "logs", "metrics", "traces", "cli"]
+authors = [{ name = "Pavel Dedík", email = "dedikx@gmail.com" }]
+maintainers = [{ name = "Pavel Dedík", email = "dedikx@gmail.com" }]
+requires-python = ">=3.11"
+license = "MIT"
+license-files = ["LICENSE"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: System :: Monitoring",
+]
+dependencies = ["httpx>=0.27"]
+
+[project.scripts]
+oo = "oo_cli.cli:main"
+# The same command under the distribution's name, so `uvx openobserve-cli ...`
+# works without installing anything.
+openobserve-cli = "oo_cli.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/paveldedik/oo-cli"
+Repository = "https://github.com/paveldedik/oo-cli"
+Issues = "https://github.com/paveldedik/oo-cli/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = ["pytest>=8", "mypy>=1.18", "ruff>=0.14"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/oo_cli"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = [
+    "E",     # flake8 rules
+    "F",     # flake8 rules
+    "B",     # flake8-bugbear
+    "C4",    # flake8-comprehensions
+    "I",     # isort
+    "D2",    # pydocstyle
+    "C901",  # maccabe complexity
+    "S",     # flake8-bandit
+    "UP",    # pyupgrade
+    "T10",   # flake8-debugger
+]
+ignore = [
+    "S101",  # asserts are how tests are written
+    "D203",
+    "D211",
+    "D213",
+]
+fixable = ["ALL"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["oo_cli"]
+
+[tool.mypy]
+python_version = "3.11"
+strict = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

openobserve_cli-0.1.0/src/oo_cli/__init__.py

@@ -0,0 +1,3 @@
+"""CLI for the OpenObserve HTTP API."""
+
+__version__ = "0.1.0"

openobserve_cli-0.1.0/src/oo_cli/__main__.py

@@ -0,0 +1,4 @@
+from oo_cli.cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())