dbabrain 0.1.0__tar.gz

dbabrain-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

dbabrain-0.1.0/NOTICE

@@ -0,0 +1,57 @@
+DBA Brain
+Copyright 2026 Trieu Tan Thanh
+
+This product includes software developed by Trieu Tan Thanh.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+--------------------------------------------------------------------------------
+Third-party dependencies
+--------------------------------------------------------------------------------
+
+DBA Brain does not bundle or modify its dependencies; they are installed from
+PyPI by pip. Distributed container images, however, do contain them, so their
+licenses are listed here.
+
+Permissively licensed (Apache-2.0, BSD, MIT or equivalent):
+
+    cryptography            Apache-2.0 OR BSD-3-Clause
+    oracledb                UPL-1.0 OR Apache-2.0
+    pyodbc                  MIT
+    pg8000                  BSD-3-Clause
+    PyMySQL                 MIT
+    PyYAML                  MIT
+    pypsrp                  MIT
+    psutil                  BSD-3-Clause
+    pytest                  MIT
+    bcrypt                  Apache-2.0
+    PyNaCl                  Apache-2.0
+    requests                Apache-2.0
+
+Weak copyleft — used as unmodified libraries, never linked statically and never
+modified. Their own license terms continue to apply to them:
+
+    paramiko                LGPL-2.1
+    pymssql                 LGPL-2.1
+    certifi                 MPL-2.0
+
+Both LGPL components are optional in the sense that they serve specific
+transports: paramiko provides SSH, and pymssql is the fallback SQL Server driver
+for hosts where ODBC/TLS negotiation fails. Anyone redistributing a container
+image that contains them inherits the LGPL obligation to make the corresponding
+source of those libraries available and to allow them to be replaced with a
+modified version; both are satisfied by shipping them unmodified from PyPI and
+by this notice.
+
+The full license text of every dependency is available in its distribution on
+PyPI and in the site-packages directory of any installation.

dbabrain-0.1.0/PKG-INFO

@@ -0,0 +1,297 @@
+Metadata-Version: 2.4
+Name: dbabrain
+Version: 0.1.0
+Summary: Database operations toolkit: metrics, reports, scheduled SQL, backup/restore validation, SLA checks.
+Author: Trieu Tan Thanh
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/tanthanhkaka01/dba-brain
+Project-URL: Repository, https://github.com/tanthanhkaka01/dba-brain
+Project-URL: Changelog, https://github.com/tanthanhkaka01/dba-brain/blob/main/CHANGELOG.md
+Keywords: dba,database,sqlserver,oracle,postgresql,mysql,monitoring,operations
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: System :: Monitoring
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: cryptography>=42.0.0
+Requires-Dist: PyYAML>=6.0.2
+Provides-Extra: mssql
+Requires-Dist: pyodbc>=5.3.0; extra == "mssql"
+Requires-Dist: pymssql>=2.3.13; extra == "mssql"
+Provides-Extra: oracle
+Requires-Dist: oracledb>=3.1.0; extra == "oracle"
+Provides-Extra: postgres
+Requires-Dist: pg8000>=1.31.0; extra == "postgres"
+Provides-Extra: mysql
+Requires-Dist: PyMySQL>=1.1.0; extra == "mysql"
+Provides-Extra: ssh
+Requires-Dist: paramiko>=3.0.0; extra == "ssh"
+Provides-Extra: winrm
+Requires-Dist: pypsrp; extra == "winrm"
+Provides-Extra: all
+Requires-Dist: pyodbc>=5.3.0; extra == "all"
+Requires-Dist: pymssql>=2.3.13; extra == "all"
+Requires-Dist: oracledb>=3.1.0; extra == "all"
+Requires-Dist: pg8000>=1.31.0; extra == "all"
+Requires-Dist: PyMySQL>=1.1.0; extra == "all"
+Requires-Dist: paramiko>=3.0.0; extra == "all"
+Requires-Dist: pypsrp; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Dynamic: license-file
+
+# DBA Brain
+
+**A database operations toolkit for people who are on call.** It collects health metrics from your
+SQL Server, Oracle, PostgreSQL and MySQL instances, grades them against policies you write, runs
+your scheduled SQL, takes backups and *proves them by restoring them*, checks objectives against
+real measurement history, and tells you about it — on a schedule, without an agent on any
+monitored machine.
+
+**It sends nothing anywhere by itself.** No telemetry, no usage reporting, no update check. It
+connects to the databases and hosts you list, and — only if you turn it on and give it a token —
+to a chat service. Nothing else.
+
+> **This project is being renamed.** The distribution and the module path are still `db_ops`, so
+> every command below reads `python -m db_ops.<app>.cli`. They become `dbabrain` when the code
+> moves to the public repository; nothing else changes with them.
+> <!-- TODO(rename): update the distribution name and every `python -m` path in this file once the
+> package rename lands. -->
+
+---
+
+## What it is not
+
+- **It is not an AI agent.** It is a toolkit with a CLI, where every capability takes one JSON
+  object and answers with one. That shape is what lets a human, a shell script, a chat command and
+  an AI agent all drive the same operation without a translation layer — and it is why an
+  agent-facing interface can be added later without rewriting anything underneath it. Today
+  nothing here talks to a model.
+- **It does not replace incident analysis, change approval, or runbooks.** It supports them. A
+  restore drill proves a backup is restorable; deciding to restore production is still yours.
+- **It is not a dashboard product.** It has a web console for reading reports and editing
+  configuration, but the primary interface is a CLI and its primary output is a record in a
+  database you own.
+- **It installs nothing on your databases.** No agent, no extension, no stored procedure. It logs
+  in with a read-only account and asks questions.
+
+## Who it is for
+
+A DBA or small team responsible for a handful to a few dozen instances across more than one
+engine, who already know what they want checked and are tired of it living in twelve cron jobs and
+a folder of scripts. If you have one PostgreSQL cluster and a hosted monitoring product you are
+happy with, this is more machinery than you need.
+
+---
+
+## Capabilities
+
+Ordered to match the reference docs; the **ORD** number links to each one.
+
+| ORD | Component | Package / config | Responsibility |
+| :---: | --- | --- | --- |
+| [01](./docs/01_runtime_store.md) | Runtime store | `db_ops/db`, `data/store_config.json` | The database the toolkit keeps its **own** data in — job runs, measurements, report state, the delivery queue, restore history. SQLite to start, PostgreSQL when you outgrow it; the backend is one word in one file. |
+| [02](./docs/02_logging_engine.md) | Logging engine | `db_ops/logging_ops`, `logs/` | Scoped application logs, runtime logs, shared errors, and daily archives. |
+| [03](./docs/03_app_command_daemon.md) | App command daemon | `db_ops/jobs`, `data/app_commands.json` | The scheduler: runs each app on its own interval inside its allowed hours, skips one that is still running, and forwards the secret passphrase to every child process. |
+| [04](./docs/04_metrics_engine.md) | Metrics engine | `db_ops/metrics`, `data/db_instances.json`, `data/metric_definitions.json` | Around ninety metrics across four engines — availability, capacity, performance, recoverability, security, maintenance — collected and normalised into one shape. |
+| [05](./docs/05_sql_task_runner.md) | SQL task runner | `db_ops/sql_tasks`, `data/sql_commands.json`, `data/sql_targets.json` | Your own SQL, on a schedule or on request, against approved targets, delivered as text or a spreadsheet. The SQL is a reviewable file, never a string in configuration. |
+| [06](./docs/06_reports_app.md) | Reports | `db_ops/reports`, `data/reports_config.json` | Turns measurements into scheduled reports and inventory pages, with a freshness gate so a stale number is never reported as a current one. |
+| [07](./docs/07_telegram_app.md) | Chat delivery and commands | `db_ops/telegram`, the Telegram data files | Delivers the outgoing queue one message at a time, and executes the commands people send back — gated by the person's clearance *and* the chat's. |
+| [08](./docs/08_backup_restore_app.md) | Backup / restore | `db_ops/backup_restore`, `data/restore_config.json` | Runs backups, restores them onto a disposable target, verifies the result, and records what was proven and when. |
+| [09](./docs/09_sla_slo_compliance_app.md) | SLA / SLO compliance | `db_ops/sla`, `data/sla_policies.json` | Computes indicators from stored measurement history, evaluates objectives with an error budget, and reports what is left of it. |
+| [10](./docs/10_sre_app.md) | SRE | `db_ops/sre`, `data/sre_config.json` | Provisions the disposable lab databases that drills and rehearsals need — single instances or small HA clusters, in Docker or on VMs. |
+| [11](./docs/11_control_app.md) | Control | `db_ops/control`, `config.json` | Builds and deploys the toolkit to another node, and watches the toolkit itself — the one app that reports on the others. |
+| [12](./docs/12_webhost_app.md) | Web host | `db_ops/webhost`, `data/webhost_config.json` | Serves the rendered reports over HTTP and hosts the console. Publishes files; never generates them. |
+| [13](./docs/13_common.md) | **Common** — shared operations | `db_ops/common` | Reaching a host, running SQL, moving a file, rotating a password, confirming something dangerous. Every command takes one JSON object. **Invoked as a CLI, never imported.** |
+| [14](./docs/14_lib.md) | **Lib** — shared rules | `db_ops/lib` | Values and rules that are pure functions of their arguments: time windows, notify routing, severity, formatting. Imports nothing from the rest of the project. **Only ever imported, never run as a CLI.** |
+
+**Fourteen components, and the list is closed.** ORD 01–12 are the apps — one directory, one CLI
+each — and 13/14 are the two shared layers they all sit on.
+
+> **Every component has a doc, and every doc has a component.** One `docs/NN_*.md` per package,
+> both directions, enforced by `tests/test_docs_cover_every_component.py`. A component is not
+> finished until its doc exists.
+>
+> That is a claim few projects can make, and it was written the hard way: one shared layer reached
+> 46 modules and roughly 6,500 lines with no documentation and a fully green suite, because nothing
+> connected the two directories.
+
+---
+
+## Install
+
+Python **3.12+**. Every database driver is an extra, so a DBA who runs only PostgreSQL is not made
+to install an ODBC driver and an Oracle client to start.
+
+```bash
+python -m venv .venv
+.venv/bin/pip install 'db_ops[postgres]'        # Windows: .venv\Scripts\pip
+```
+
+| Extra | For |
+| --- | --- |
+| `[postgres]` | PostgreSQL — pure Python, nothing else to install |
+| `[mysql]` | MySQL / MariaDB — pure Python |
+| `[oracle]` | Oracle — no client library needed for 12.1 and newer |
+| `[mssql]` | SQL Server — **also needs Microsoft's system ODBC driver** |
+| `[ssh]`, `[winrm]` | OS-level metrics and maintenance on Linux / Windows targets |
+| `[all]` | everything |
+
+Full instructions, including the two prerequisites that are not pip-installable and the container
+image: **[`docs/installation.md`](./docs/installation.md)**.
+
+## Five minutes
+
+A throwaway container, a least-privilege login, seven real measurements — and nothing to uninstall
+afterwards:
+
+**[`examples/postgres-quickstart/`](./examples/postgres-quickstart)** — needs no system packages.
+**[`examples/sqlserver-quickstart/`](./examples/sqlserver-quickstart)** — same shape, and it finds
+a real problem with the instance, then clears it once you fix it.
+
+```bash
+cd examples/postgres-quickstart
+docker compose up -d
+python -m db_ops.db.cli      --config config.json init
+python -m db_ops.metrics.cli --config config.json collect --dry-run
+python -m db_ops.metrics.cli --config config.json collect
+python -m db_ops.metrics.cli --config config.json report
+```
+
+---
+
+## Two ways to drive it
+
+After `pip install`, someone has to describe the estate — which instances exist, which credentials
+reach them, where alerts go. There are two ways to do that, and they differ only in who writes the
+files.
+
+| | Who configures it | Status |
+| --- | --- | --- |
+| **A person, in a browser** | A web console: add an instance the way a database client does — host, port, user, password — and it collects | **Planned.** The console exists and edits configuration; the add-an-instance flow does not, and `webhost` is not in `v0.1.0` |
+| **An agent, writing JSON** | Every decision is a file. An agent writes them and runs three commands | **This is the supported path today** |
+
+`v0.1.0` ships the agent path on purpose: the configuration surface has to be settled before
+something generates it, and a console that writes files nobody has agreed the shape of becomes a
+second source of truth.
+
+**Both paths are written out step by step, with what to assert after each one, in
+[`docs/first_run.md`](./docs/first_run.md).** It is written to be followed by a program and to be
+readable by a person, because until the console lands they do the same thing.
+
+---
+
+## How it is configured
+
+Everything is JSON you own. **A new threshold, target, route, schedule or severity belongs in
+`data/*.json`, never as a literal in Python** — the design assumes the person affected by a setting
+can read it, change it, and be reviewed on the change.
+
+```text
+config.json      → where runtime output goes, and which declaration files to read
+data/*.json      → what to run, monitor, report and deliver
+secrets/         → the plaintext source of the encrypted secret store (git-ignored)
+assets/          → the SQL and scripts that implement it
+```
+
+Every configuration file has a `*.example.json` beside it, complete enough to copy, rename and
+edit, with a `notes` array explaining what it decides and why.
+
+**The tool finds its configuration by a stated order**, not by where its code sits on disk:
+`DB_OPS_HOME`, then the working directory if it holds `data/` or `config.json`, then the package
+location. That is what makes an installed copy work, and it is why standing in an example
+directory is enough to run against it.
+
+See **[`docs/configuration.md`](./docs/configuration.md)**.
+
+## Secrets
+
+Passwords and tokens live encrypted in `data/encrypted_secret_text.json` — PBKDF2-HMAC-SHA256 over
+a per-file salt, sealed with Fernet. The passphrase is supplied at run time and is never written to
+disk, a log, or the store. Configuration names a *reference*; the value is resolved from the
+environment first and the encrypted store second, so an organisation with an external secret
+manager never has to use the built-in one.
+
+A request carrying a password is passed on **stdin**, never as a command-line word — argv is
+world-readable in the process table.
+
+See **[`docs/security.md`](./docs/security.md)**, which also covers the least-privilege login the
+toolkit needs on each engine, the audit trail, and running with no outbound network access.
+
+## How it is put together
+
+Fourteen components, two shared layers, four rules about who may call whom — and a guard test
+beside each rule, because a diagram describes what someone intended and a test describes what is
+true this morning.
+
+> `common` **may not be imported** — it is only ever run as a CLI.
+> `lib` **may not run a CLI** — it is only ever imported.
+> No app imports another app.
+> No shared layer imports an app.
+
+See **[`docs/architecture.md`](./docs/architecture.md)**.
+
+---
+
+## Documentation
+
+| Start here | |
+| --- | --- |
+| [`docs/installation.md`](./docs/installation.md) | pip and Docker, the engine extras, the ODBC and Oracle prerequisites |
+| [`docs/first_run.md`](./docs/first_run.md) | From `pip install` to a collected metric — the agent path in full, and what the browser path will be |
+| [`docs/configuration.md`](./docs/configuration.md) | Where configuration lives, and what every file decides |
+| [`docs/security.md`](./docs/security.md) | Secrets, least privilege, the audit trail, air-gapped operation |
+| [`docs/architecture.md`](./docs/architecture.md) | The components, the layers, and the rules that keep them apart |
+| [`examples/`](./examples) | Worked configurations you can copy whole |
+
+| Component reference | |
+| --- | --- |
+| [`docs/01_runtime_store.md`](./docs/01_runtime_store.md) | Store backends, schema, migration, troubleshooting |
+| [`docs/02_logging_engine.md`](./docs/02_logging_engine.md) | Log scopes, files, and archive behaviour |
+| [`docs/03_app_command_daemon.md`](./docs/03_app_command_daemon.md) | Scheduling, time windows, timeouts, key forwarding |
+| [`docs/04_metrics_engine.md`](./docs/04_metrics_engine.md) | The metric catalogue per engine, and least-privilege setup |
+| [`docs/05_sql_task_runner.md`](./docs/05_sql_task_runner.md) | SQL task configuration, parameters, and execution |
+| [`docs/06_reports_app.md`](./docs/06_reports_app.md) | Report creation, schedules, and finding delivery |
+| [`docs/07_telegram_app.md`](./docs/07_telegram_app.md) | Delivery, bot commands, and permissions |
+| [`docs/08_backup_restore_app.md`](./docs/08_backup_restore_app.md) | Backup, restore, verification, and history |
+| [`docs/09_sla_slo_compliance_app.md`](./docs/09_sla_slo_compliance_app.md) | Objectives, indicators, and error budgets |
+| [`docs/10_sre_app.md`](./docs/10_sre_app.md) | Lab provisioning, HA topologies, and delegated workflows |
+| [`docs/11_control_app.md`](./docs/11_control_app.md) | Build, deploy, and watching the toolkit itself |
+| [`docs/12_webhost_app.md`](./docs/12_webhost_app.md) | Serving reports, the stable `latest` link, snapshot selection |
+| [`docs/13_common.md`](./docs/13_common.md) | The shared operations layer, command by command |
+| [`docs/14_lib.md`](./docs/14_lib.md) | The pure rules layer, the purity guarantee, and the module index |
+
+| Project | |
+| --- | --- |
+| [`CONTRIBUTING.md`](./CONTRIBUTING.md) | How to contribute, and the rules that exist because something broke |
+| [`SECURITY.md`](./SECURITY.md) | Reporting a vulnerability |
+| [`CHANGELOG.md`](./CHANGELOG.md) | What changed, written for someone deciding whether to upgrade |
+| [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md) | |
+
+---
+
+## Tests
+
+The suite is **offline**: no database, no network, no delivery. That is why it runs anywhere and
+why you can refactor with it.
+
+```bash
+.venv/bin/python -m pytest tests -q                    # full suite
+.venv/bin/python -m pytest tests/test_<area>.py -q     # while developing
+```
+
+Tests read as prose — a module docstring explaining *why the behaviour matters*, then test names
+that are sentences.
+
+## License
+
+[Apache License 2.0](./LICENSE). See [`NOTICE`](./NOTICE).