ojiichan 0.1.0__tar.gz

ojiichan-0.1.0/.gitignore

@@ -0,0 +1,173 @@
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+.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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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
+.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/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Ruff
+.ruff_cache/
+
+# Environments / secrets
+.env.*
+.locke/config.json
+
+# Local hook/debug outputs
+/hook_outputs/
+**/hook_outputs/

ojiichan-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Martin Wieser
+
+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.

ojiichan-0.1.0/PKG-INFO

@@ -0,0 +1,180 @@
+Metadata-Version: 2.4
+Name: ojiichan
+Version: 0.1.0
+Summary: Pseekoo diagnostics toolkit for ELK, Bugsink/Sentry, and issue handoff workflows.
+Project-URL: Homepage, https://gitlab.com/pseekoo/ojiichan
+Project-URL: Repository, https://gitlab.com/pseekoo/ojiichan
+Project-URL: Issues, https://gitlab.com/pseekoo/ojiichan/-/issues
+Author-email: Martin Wieser <martin.wieser@pseekoo.com>
+License: MIT License
+        
+        Copyright (c) 2026 Martin Wieser
+        
+        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.
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+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 :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Logging
+Requires-Python: >=3.11
+Requires-Dist: elasticsearch<9.0,>=8.0
+Requires-Dist: httpx>=0.27
+Requires-Dist: mcp>=1.0
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: sentry-sdk>=2.22
+Provides-Extra: vault
+Requires-Dist: locke>=0.5.2; extra == 'vault'
+Description-Content-Type: text/markdown
+
+# ojiichan
+
+Pseekoo diagnostics toolkit for projects that report to **ELK** and **Bugsink/Sentry**.
+
+It provides both:
+
+- a Python library (`ojiichan`) for structured ELK events and Sentry/Bugsink setup;
+- a CLI (`ojiichan`) for health checks, recent logs, and test event emission.
+
+It standardizes the same observability workflow across Python services.
+
+## Install
+
+```bash
+uv add ojiichan
+# with Locke/Vaultwarden credential support:
+uv add "ojiichan[vault]"
+# or for development:
+uv sync
+```
+
+## Configuration and credentials
+
+Ojiichan resolves explicit environment variables first, then Locke/Vaultwarden secrets when installed with the `vault` extra. The checked-in `locke.json` documents the expected Vaultwarden paths; no sample env file with secret-shaped values is needed.
+
+Default vault folder: `ojiichan`.
+Override it with `OJIICHAN_VAULT_FOLDER` when needed.
+
+Non-secret options can still be set as env vars, for example `ELASTICSEARCH_PORT`, `ELASTICSEARCH_USE_SSL`, `ELASTICSEARCH_VERIFY_CERTS`, `ELASTICSEARCH_TIMEOUT`, and `BUGSINK_TIMEOUT`.
+
+## CLI
+
+```bash
+ojiichan health --hours 6
+ojiichan logs --hours 2 --topic matrix --failures-only
+ojiichan emit matrix_exchange_failed --topic auth --level error --failure \
+  --data '{"operation":"matrix_exchange","room_id":"!abc"}'
+```
+
+## Library
+
+```python
+from ojiichan import ElkClient, init_sentry
+
+init_sentry(service="stoz3n-chat-agent", environment="development")
+
+elk = ElkClient(service="stoz3n-chat-agent")
+elk.log_event(
+    "matrix_exchange_start",
+    {"operation": "matrix_exchange", "user_id": "@user:example.org"},
+    topic="auth",
+)
+```
+
+For exception paths:
+
+```python
+try:
+    ...
+except Exception as exc:
+    elk.log_event(
+        "matrix_exchange_failed",
+        {"operation": "matrix_exchange", "error": str(exc)},
+        level="error",
+        topic="auth",
+        failure=True,
+    )
+    raise
+```
+
+## MCP server
+
+Ojiichan also ships a local stdio MCP server so coding agents can query diagnostics and run repeatable test/build checks without hardcoding shell snippets.
+
+Run it manually:
+
+```bash
+uv run ojiichan-mcp
+```
+
+Example MCP client config:
+
+```json
+{
+  "mcpServers": {
+    "ojiichan": {
+      "command": "uv",
+      "args": [
+        "run",
+        "--with",
+        "ojiichan[vault]",
+        "ojiichan-mcp"
+      ]
+    }
+  }
+}
+```
+
+Exposed tools:
+
+- `elk_health`
+- `elk_logs`
+- `emit_elk_event`
+- `bugsink_health`
+- `bugsink_issues`
+- `create_bead_from_issue`
+- `xcode_build`
+- `xcode_test`
+
+For Xcode projects, an agent can call `xcode_test` with a local `project_path`, `scheme`, and `destination`.
+
+## Release
+
+Publishing is handled by GitLab CI in the public `pseekoo/ojiichan` repository:
+
+- pushes to the default branch publish a PEP 440 dev build to the GitLab PyPI registry;
+- tags matching `vX.Y.Z` publish the release to the GitLab PyPI registry and to pypi.org;
+- tagged releases require `PYPI_API_TOKEN` in GitLab CI variables.
+
+To release the current version:
+
+```bash
+git tag v0.1.0
+git push origin main --tags
+```
+
+## Notes
+
+- Bugsink ingestion uses the normal Sentry SDK via `SENTRY_DSN`.
+- Bugsink issue reads use the canonical read API at `/api/canonical/0/issues/` and require `BUGSINK_API_TOKEN`.
+- Beads integration is intentionally optional; `ojiichan.beads` shells out only when `bead`/`beads` is installed.
+- The public distribution and import package are both `ojiichan`; the GitLab repository can live under the `pseekoo` group without changing Python names.

ojiichan-0.1.0/README.md

@@ -0,0 +1,132 @@
+# ojiichan
+
+Pseekoo diagnostics toolkit for projects that report to **ELK** and **Bugsink/Sentry**.
+
+It provides both:
+
+- a Python library (`ojiichan`) for structured ELK events and Sentry/Bugsink setup;
+- a CLI (`ojiichan`) for health checks, recent logs, and test event emission.
+
+It standardizes the same observability workflow across Python services.
+
+## Install
+
+```bash
+uv add ojiichan
+# with Locke/Vaultwarden credential support:
+uv add "ojiichan[vault]"
+# or for development:
+uv sync
+```
+
+## Configuration and credentials
+
+Ojiichan resolves explicit environment variables first, then Locke/Vaultwarden secrets when installed with the `vault` extra. The checked-in `locke.json` documents the expected Vaultwarden paths; no sample env file with secret-shaped values is needed.
+
+Default vault folder: `ojiichan`.
+Override it with `OJIICHAN_VAULT_FOLDER` when needed.
+
+Non-secret options can still be set as env vars, for example `ELASTICSEARCH_PORT`, `ELASTICSEARCH_USE_SSL`, `ELASTICSEARCH_VERIFY_CERTS`, `ELASTICSEARCH_TIMEOUT`, and `BUGSINK_TIMEOUT`.
+
+## CLI
+
+```bash
+ojiichan health --hours 6
+ojiichan logs --hours 2 --topic matrix --failures-only
+ojiichan emit matrix_exchange_failed --topic auth --level error --failure \
+  --data '{"operation":"matrix_exchange","room_id":"!abc"}'
+```
+
+## Library
+
+```python
+from ojiichan import ElkClient, init_sentry
+
+init_sentry(service="stoz3n-chat-agent", environment="development")
+
+elk = ElkClient(service="stoz3n-chat-agent")
+elk.log_event(
+    "matrix_exchange_start",
+    {"operation": "matrix_exchange", "user_id": "@user:example.org"},
+    topic="auth",
+)
+```
+
+For exception paths:
+
+```python
+try:
+    ...
+except Exception as exc:
+    elk.log_event(
+        "matrix_exchange_failed",
+        {"operation": "matrix_exchange", "error": str(exc)},
+        level="error",
+        topic="auth",
+        failure=True,
+    )
+    raise
+```
+
+## MCP server
+
+Ojiichan also ships a local stdio MCP server so coding agents can query diagnostics and run repeatable test/build checks without hardcoding shell snippets.
+
+Run it manually:
+
+```bash
+uv run ojiichan-mcp
+```
+
+Example MCP client config:
+
+```json
+{
+  "mcpServers": {
+    "ojiichan": {
+      "command": "uv",
+      "args": [
+        "run",
+        "--with",
+        "ojiichan[vault]",
+        "ojiichan-mcp"
+      ]
+    }
+  }
+}
+```
+
+Exposed tools:
+
+- `elk_health`
+- `elk_logs`
+- `emit_elk_event`
+- `bugsink_health`
+- `bugsink_issues`
+- `create_bead_from_issue`
+- `xcode_build`
+- `xcode_test`
+
+For Xcode projects, an agent can call `xcode_test` with a local `project_path`, `scheme`, and `destination`.
+
+## Release
+
+Publishing is handled by GitLab CI in the public `pseekoo/ojiichan` repository:
+
+- pushes to the default branch publish a PEP 440 dev build to the GitLab PyPI registry;
+- tags matching `vX.Y.Z` publish the release to the GitLab PyPI registry and to pypi.org;
+- tagged releases require `PYPI_API_TOKEN` in GitLab CI variables.
+
+To release the current version:
+
+```bash
+git tag v0.1.0
+git push origin main --tags
+```
+
+## Notes
+
+- Bugsink ingestion uses the normal Sentry SDK via `SENTRY_DSN`.
+- Bugsink issue reads use the canonical read API at `/api/canonical/0/issues/` and require `BUGSINK_API_TOKEN`.
+- Beads integration is intentionally optional; `ojiichan.beads` shells out only when `bead`/`beads` is installed.
+- The public distribution and import package are both `ojiichan`; the GitLab repository can live under the `pseekoo` group without changing Python names.

ojiichan-0.1.0/locke.json

@@ -0,0 +1,28 @@
+{
+  "version": 2,
+  "project": "ojiichan",
+  "tenant": "default",
+  "keys": {
+    "_comment": "Ojiichan credential registry. Secret values live in Locke/Vaultwarden, not in sample env files.",
+    "vault": {
+      "_comment": "Path format: {project}/{tenant}/{name}. Ojiichan also supports OJIICHAN_VAULT_FOLDER to override the folder prefix.",
+      "ojiichan/elasticsearch-host": "Elasticsearch host or base URL",
+      "ojiichan/elasticsearch-username": "Elasticsearch username",
+      "ojiichan/elasticsearch-password": "Elasticsearch password",
+      "ojiichan/elasticsearch-index-prefix": "Default Elasticsearch index prefix",
+      "ojiichan/sentry-dsn": "Sentry/Bugsink ingest DSN",
+      "ojiichan/bugsink-api-token": "Bugsink API token for issue reads",
+      "ojiichan/bugsink-host": "Bugsink host when not derivable from DSN",
+      "ojiichan/bugsink-project-id": "Bugsink project id when not derivable from DSN"
+    },
+    "env": {
+      "_comment": "Non-secret runtime options or explicit local overrides.",
+      "OJIICHAN_VAULT_FOLDER": "Optional Vaultwarden folder prefix; defaults to ojiichan",
+      "ELASTICSEARCH_PORT": "Elasticsearch port; defaults to 443",
+      "ELASTICSEARCH_USE_SSL": "true/false; defaults to true",
+      "ELASTICSEARCH_VERIFY_CERTS": "true/false; defaults to true",
+      "ELASTICSEARCH_TIMEOUT": "Elasticsearch timeout seconds; defaults to 10",
+      "BUGSINK_TIMEOUT": "Bugsink API timeout seconds; defaults to 10"
+    }
+  }
+}

ojiichan-0.1.0/pyproject.toml

@@ -0,0 +1,62 @@
+[project]
+name = "ojiichan"
+version = "0.1.0"
+description = "Pseekoo diagnostics toolkit for ELK, Bugsink/Sentry, and issue handoff workflows."
+readme = "README.md"
+license = { file = "LICENSE" }
+authors = [{ name = "Martin Wieser", email = "martin.wieser@pseekoo.com" }]
+requires-python = ">=3.11"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Topic :: System :: Logging",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "elasticsearch>=8.0,<9.0",
+    "httpx>=0.27",
+    "mcp>=1.0",
+    "python-dotenv>=1.0",
+    "sentry-sdk>=2.22",
+]
+
+[project.optional-dependencies]
+vault = [
+    "locke>=0.5.2",
+]
+
+[project.urls]
+Homepage = "https://gitlab.com/pseekoo/ojiichan"
+Repository = "https://gitlab.com/pseekoo/ojiichan"
+Issues = "https://gitlab.com/pseekoo/ojiichan/-/issues"
+
+[project.scripts]
+ojiichan = "ojiichan.cli:main"
+ojiichan-mcp = "ojiichan_mcp.server:main"
+
+[dependency-groups]
+dev = [
+    "pytest>=8",
+    "ruff>=0.8",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/ojiichan", "src/ojiichan_mcp"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/ojiichan", "src/ojiichan_mcp", "README.md", "LICENSE", "locke.json", "pyproject.toml"]

ojiichan-0.1.0/src/ojiichan/__init__.py

@@ -0,0 +1,16 @@
+"""Ojiichan diagnostics toolkit."""
+
+from .bugsink import BugsinkClient, BugsinkIssue, check_bugsink
+from .elk import ElkClient, check_elk, query_elk_logs
+from .sentry import capture_exception, init_sentry
+
+__all__ = [
+    "BugsinkClient",
+    "BugsinkIssue",
+    "ElkClient",
+    "capture_exception",
+    "check_bugsink",
+    "check_elk",
+    "init_sentry",
+    "query_elk_logs",
+]

ojiichan-0.1.0/src/ojiichan/beads.py

@@ -0,0 +1,29 @@
+"""Optional Beads issue-tracker handoff helpers.
+
+This intentionally shells out to `bead`/`beads` when present instead of taking a
+hard dependency on a Python API, so ojiichan remains reusable in projects that do
+not use Beads.
+"""
+
+from __future__ import annotations
+
+import shutil
+import subprocess
+
+
+def beads_available() -> bool:
+    return bool(shutil.which("bead") or shutil.which("beads"))
+
+
+def create_bead(title: str, body: str, *, labels: list[str] | None = None) -> bool:
+    exe = shutil.which("bead") or shutil.which("beads")
+    if not exe:
+        return False
+    cmd = [exe, "create", title, "--body", body]
+    for label in labels or []:
+        cmd.extend(["--label", label])
+    try:
+        subprocess.run(cmd, check=True)
+        return True
+    except Exception:
+        return False