cpkit 0.1.0__tar.gz

cpkit-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.

cpkit-0.1.0/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: cpkit
+Version: 0.1.0
+Summary: Reusable control-plane framework extracted from cp.
+License-Expression: Apache-2.0
+License-File: LICENSE
+Author: Your Name
+Author-email: you@example.com
+Requires-Python: >=3.14
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: PyJWT (>=2.10.1,<3.0.0)
+Requires-Dist: ansible-runner (>=2.4.3,<3.0.0)
+Requires-Dist: cryptography (>=46.0.7,<47.0.0)
+Requires-Dist: fastapi[standard] (>=0.135.3,<0.136.0)
+Requires-Dist: psycopg (>=3.3.3,<4.0.0)
+Requires-Dist: psycopg-binary (>=3.3.3,<4.0.0)
+Requires-Dist: psycopg-pool (>=3.3.0,<4.0.0)
+Requires-Dist: pydantic (>=2.12.0,<3.0.0)
+Requires-Dist: systemd-python (>=235,<236) ; sys_platform == "linux"
+Description-Content-Type: text/markdown
+
+# cpkit
+
+cpkit is an early-stage framework for building small control-plane applications
+on FastAPI and Postgres-compatible databases.
+
+It is meant for applications that need more than CRUD endpoints but should not
+have to rebuild the same operational foundation every time: authentication,
+settings, audit logging, job execution, playbook storage, database wiring, and a
+basic web console.
+
+cpkit is still immature, but it is already usable as a foundation for apps that
+want to focus on their domain model while inheriting common control-plane
+capabilities.
+
+## Why cpkit?
+
+Control-plane apps tend to repeat the same infrastructure:
+
+- API key and OIDC authentication
+- role-aware API dependencies
+- durable settings stored in the database
+- audit events and request logging
+- durable job queues and background workers
+- versioned playbooks and Ansible execution
+- consistent service/repository error handling
+- a minimal admin web UI
+
+cpkit packages those pieces as framework capabilities. The application provides
+its business routers, services, repositories, models, and job handlers; cpkit
+provides the surrounding platform.
+
+## What You Get
+
+- FastAPI app bootstrap with cpkit routers mounted under `/api`
+- A repository base class for framework-owned tables
+- Built-in settings, events, jobs, API keys, auth, and playbooks APIs
+- A durable message queue and worker loop for application jobs
+- OIDC sessions and signed API-key authentication
+- Request logging and audit event helpers
+- A packaged template webapp for framework/admin pages
+- A standard CLI with `serve` and `init`
+
+## Try The TODO Example
+
+The best way to understand cpkit is to run the TODO example:
+
+[examples/todo_app](examples/todo_app)
+
+The example is intentionally small, but it is not toy scaffolding. It shows a
+real cpkit app with:
+
+- its own `todos` table
+- TODO API routes
+- a service layer
+- a repository extending cpkit's repository base
+- a cpkit-managed FastAPI app
+- cpkit settings, events, jobs, API keys, auth, and playbooks
+- an `EXPORT_TODOS` job that writes TODOs to JSON or CSV files
+
+Run it:
+
+```bash
+cd examples/todo_app
+poetry install
+export CPKIT_DB_URL='postgres://...'
+export CPKIT_MASTER_KEY='base64-encoded-32-byte-key'
+poetry run todo init
+poetry run todo serve --reload
+```
+
+Then open:
+
+- Web console: `http://localhost:8000/`
+- API docs: `http://localhost:8000/api/docs`
+
+## Project Status
+
+cpkit is independent and evolving. The APIs are not yet stable, and the TODO app
+is the current reference for the recommended application structure.
+
+Expect the framework to keep moving toward a clearer extension model: cpkit owns
+the operational platform, while applications plug in business logic.
+

cpkit-0.1.0/README.md

@@ -0,0 +1,82 @@
+# cpkit
+
+cpkit is an early-stage framework for building small control-plane applications
+on FastAPI and Postgres-compatible databases.
+
+It is meant for applications that need more than CRUD endpoints but should not
+have to rebuild the same operational foundation every time: authentication,
+settings, audit logging, job execution, playbook storage, database wiring, and a
+basic web console.
+
+cpkit is still immature, but it is already usable as a foundation for apps that
+want to focus on their domain model while inheriting common control-plane
+capabilities.
+
+## Why cpkit?
+
+Control-plane apps tend to repeat the same infrastructure:
+
+- API key and OIDC authentication
+- role-aware API dependencies
+- durable settings stored in the database
+- audit events and request logging
+- durable job queues and background workers
+- versioned playbooks and Ansible execution
+- consistent service/repository error handling
+- a minimal admin web UI
+
+cpkit packages those pieces as framework capabilities. The application provides
+its business routers, services, repositories, models, and job handlers; cpkit
+provides the surrounding platform.
+
+## What You Get
+
+- FastAPI app bootstrap with cpkit routers mounted under `/api`
+- A repository base class for framework-owned tables
+- Built-in settings, events, jobs, API keys, auth, and playbooks APIs
+- A durable message queue and worker loop for application jobs
+- OIDC sessions and signed API-key authentication
+- Request logging and audit event helpers
+- A packaged template webapp for framework/admin pages
+- A standard CLI with `serve` and `init`
+
+## Try The TODO Example
+
+The best way to understand cpkit is to run the TODO example:
+
+[examples/todo_app](examples/todo_app)
+
+The example is intentionally small, but it is not toy scaffolding. It shows a
+real cpkit app with:
+
+- its own `todos` table
+- TODO API routes
+- a service layer
+- a repository extending cpkit's repository base
+- a cpkit-managed FastAPI app
+- cpkit settings, events, jobs, API keys, auth, and playbooks
+- an `EXPORT_TODOS` job that writes TODOs to JSON or CSV files
+
+Run it:
+
+```bash
+cd examples/todo_app
+poetry install
+export CPKIT_DB_URL='postgres://...'
+export CPKIT_MASTER_KEY='base64-encoded-32-byte-key'
+poetry run todo init
+poetry run todo serve --reload
+```
+
+Then open:
+
+- Web console: `http://localhost:8000/`
+- API docs: `http://localhost:8000/api/docs`
+
+## Project Status
+
+cpkit is independent and evolving. The APIs are not yet stable, and the TODO app
+is the current reference for the recommended application structure.
+
+Expect the framework to keep moving toward a clearer extension model: cpkit owns
+the operational platform, while applications plug in business logic.

cpkit-0.1.0/cpkit/README.md

@@ -0,0 +1,82 @@
+# cpkit Code Map
+
+cpkit is an application framework for FastAPI apps that want the same
+operational backbone: authentication, audit events, settings, jobs, playbooks,
+database helpers, and a shared webapp shell.
+
+The package is organized by capability. The directories look flat at first
+glance, but most capability packages use the same internal pattern:
+
+- `types.py`: Pydantic models, enums, and response shapes.
+- `repository.py` or `repositories.py`: database mixins for framework-owned
+  tables.
+- `service.py`: business rules and repository error translation.
+- `router.py`: FastAPI routes and dependency wiring.
+- `__init__.py`: public exports for that capability.
+
+The main app flow is:
+
+1. An app calls `create_cpkit_bundle()` from `bundle.py` to assemble cpkit
+   capabilities.
+2. The app calls `create_cpkit_app()` from `app.py` to create the FastAPI app,
+   configure the repository, run startup hooks, mount routers, and launch
+   background tasks.
+3. `repository.py` provides `CPKitRepo`, a mix of all framework repository
+   capabilities. Apps can subclass it and add their own repository methods.
+4. Capability services use `get_repo()` to work with the configured app repo.
+5. The shared webapp in `webapp/` talks to the framework API routes and can be
+   extended by app-owned web assets.
+
+## Architecture Review
+
+The current flat capability layout is reasonable for cpkit's size. It keeps
+imports readable and makes each framework feature easy to find. A deeper layout
+like `cpkit/core`, `cpkit/capabilities`, and `cpkit/integrations` might become
+useful later, but moving there now would mostly create import churn.
+
+The part that made the project feel like a black box was not the package shape;
+it was the lack of an orientation layer. These README files are intended to be
+that layer. They explain the module boundaries without changing runtime code.
+
+Good rules of thumb:
+
+- Start in `bundle.py` when asking "how does cpkit assemble itself?"
+- Start in `app.py` when asking "how does cpkit become a FastAPI app?"
+- Start in `repository.py` when asking "how do framework services reach the DB?"
+- Start in a capability package when asking about one feature area.
+- Start in `webapp/README.md` for frontend extension behavior.
+
+## Top-Level Modules
+
+- `app.py`: FastAPI app bootstrap, lifespan management, router mounting, static
+  webapp mounting, DB initialization, and background task startup.
+- `bundle.py`: The standard cpkit capability bundle. It wires auth, jobs,
+  events, admin routes, settings, playbooks, API keys, audit hooks, and the
+  queue worker.
+- `repository.py`: The framework repository composition point. `CPKitRepo`
+  combines all cpkit repository mixins; `configure_repository()` tells cpkit how
+  to create app repo instances.
+- `resources/`: Packaged framework resources such as `ddl.sql`. Use
+  `cpkit_ddl_path()` to locate them from installed wheels.
+- `admin.py`: Composes built-in admin routers under the admin API prefix.
+- `dependencies.py`: Global dependency accessors used by routers after a bundle
+  has been configured.
+- `time.py`: Shared timestamp formatting constants.
+
+## Capability Packages
+
+- `audit/`: audit event records, event reads, audit hooks, and the context used
+  to attach request/job identifiers.
+- `auth/`: OIDC login/logout, API key auth, role/group mapping, encrypted
+  secrets, and auth dependencies.
+- `cli/`: reusable app CLI for schema initialization, schema checks, and serving.
+- `config/`: small environment/config helpers.
+- `db/`: database pool, query helpers, Cockroach/Postgres compatibility, and
+  DB error translation.
+- `errors/`: repository/service/http exception layers.
+- `jobs/`: framework job table, queue table, queue worker, job APIs, and job
+  rescheduling.
+- `logging/`: request id context, middleware, and logging setup.
+- `playbooks/`: versioned playbook storage and Ansible runner integration.
+- `settings/`: framework settings table and admin settings API.
+- `webapp/`: static HTML/CSS/JS shell and extension contract for app UIs.

cpkit-0.1.0/cpkit/__init__.py

@@ -0,0 +1,42 @@
+"""Reusable control-plane framework primitives."""
+
+from .admin import create_cpkit_admin_router
+from .app import create_cpkit_app
+from .bundle import CpkitBundle, create_cpkit_bundle
+from .cli import ApplicationCLI
+from .dependencies import (
+    configure_cpkit_dependencies,
+    get_access_scope,
+    get_audit_actor,
+    require_admin,
+    require_authenticated,
+    require_readonly,
+    require_user,
+)
+from .repository import CPKitRepo, configure_repository, get_repo
+from .resources import cpkit_ddl_path, cpkit_resources_directory
+from .time import STRFTIME, TS_FORMAT
+from .webapp import template_webapp_directory
+
+__all__ = [
+    "CPKitRepo",
+    "ApplicationCLI",
+    "CpkitBundle",
+    "STRFTIME",
+    "TS_FORMAT",
+    "configure_cpkit_dependencies",
+    "configure_repository",
+    "create_cpkit_bundle",
+    "create_cpkit_admin_router",
+    "create_cpkit_app",
+    "cpkit_ddl_path",
+    "cpkit_resources_directory",
+    "get_access_scope",
+    "get_audit_actor",
+    "get_repo",
+    "require_admin",
+    "require_authenticated",
+    "require_readonly",
+    "require_user",
+    "template_webapp_directory",
+]

cpkit-0.1.0/cpkit/admin.py

@@ -0,0 +1,53 @@
+"""Admin router assembly for framework-owned capabilities."""
+
+from collections.abc import Callable, Sequence
+from typing import Any
+
+from fastapi import APIRouter
+
+from .auth import create_api_keys_router
+from .playbooks import create_playbooks_router
+from .settings import create_settings_router
+
+
+def create_cpkit_admin_router(
+    *,
+    get_api_keys_service: Callable[..., Any],
+    get_settings_service: Callable[..., Any],
+    get_playbooks_service: Callable[..., Any],
+    get_audit_actor: Callable[..., Any],
+    handle_service_error: Callable[[Exception], None],
+    service_error_type: type[Exception] = Exception,
+    prefix: str = "/admin",
+    dependencies: Sequence[Any] | None = None,
+) -> APIRouter:
+    """Create the standard admin routes provided by cpkit."""
+    router = APIRouter(
+        prefix=prefix,
+        dependencies=list(dependencies or ()),
+    )
+    router.include_router(
+        create_settings_router(
+            get_service=get_settings_service,
+            get_audit_actor=get_audit_actor,
+            handle_service_error=handle_service_error,
+            service_error_type=service_error_type,
+        )
+    )
+    router.include_router(
+        create_playbooks_router(
+            get_service=get_playbooks_service,
+            get_audit_actor=get_audit_actor,
+            handle_service_error=handle_service_error,
+            service_error_type=service_error_type,
+        )
+    )
+    router.include_router(
+        create_api_keys_router(
+            get_service=get_api_keys_service,
+            get_audit_actor=get_audit_actor,
+            handle_service_error=handle_service_error,
+            service_error_type=service_error_type,
+        )
+    )
+    return router