codex-fastapi-cabinet 0.1.0__tar.gz

codex_fastapi_cabinet-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.coverage
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.venv/
+.uv-cache/
+build/
+dist/
+htmlcov/
+site/

codex_fastapi_cabinet-0.1.0/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project
+uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-07-19
+
+### Added
+
+- Application-scoped `CabinetSite` and deterministic admin registry.
+- Generic list, detail, form, and operation page contracts.
+- Metric, table, list, and chart widget contracts.
+- Permission port for modules, pages, widgets, navigation, and actions.
+- Explicit module loading through `register_cabinet` or `CABINET_ADMINS`.
+- Overridable Jinja templates, responsive static assets, examples, and EN/RU documentation.

codex_fastapi_cabinet-0.1.0/LICENSE

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

codex_fastapi_cabinet-0.1.0/PKG-INFO

@@ -0,0 +1,182 @@
+Metadata-Version: 2.4
+Name: codex-fastapi-cabinet
+Version: 0.1.0
+Summary: Composable administration interfaces for FastAPI sites and APIs
+Project-URL: Homepage, https://github.com/CodexDLC/codex-fastapi-cabinet
+Project-URL: Documentation, https://codexdlc.github.io/codex-fastapi-cabinet/
+Project-URL: Repository, https://github.com/CodexDLC/codex-fastapi-cabinet
+Project-URL: Issues, https://github.com/CodexDLC/codex-fastapi-cabinet/issues
+Author: CodexDLC
+License: Apache-2.0
+License-File: LICENSE
+Keywords: admin,dashboard,fastapi,jinja2,management
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.12
+Requires-Dist: fastapi<1.0,>=0.115
+Requires-Dist: jinja2<4.0,>=3.1
+Requires-Dist: pydantic<3.0,>=2.10
+Provides-Extra: dev
+Requires-Dist: httpx>=0.28; extra == 'dev'
+Requires-Dist: mypy>=1.15; extra == 'dev'
+Requires-Dist: pip-audit>=2.7; extra == 'dev'
+Requires-Dist: pre-commit>=4.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=1.0; extra == 'dev'
+Requires-Dist: pytest-cov>=6.0; extra == 'dev'
+Requires-Dist: pytest>=9.0; extra == 'dev'
+Requires-Dist: ruff>=0.11; extra == 'dev'
+Requires-Dist: twine>=6.1; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mike>=2.1; extra == 'docs'
+Requires-Dist: mkdocs-include-markdown-plugin>=7.1; extra == 'docs'
+Requires-Dist: mkdocs-material>=9.6; extra == 'docs'
+Requires-Dist: mkdocs<2.0,>=1.6; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.29; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# codex-fastapi-cabinet
+
+Composable, server-rendered administration interfaces for FastAPI sites and APIs.
+
+The library provides the management shell, routing, navigation, generic pages, dashboard widgets,
+permissions port, Jinja templates, and static assets. Your FastAPI application keeps ownership of
+authentication, authorization rules, database access, transactions, and business operations.
+
+> Status: alpha. The public API is usable, but may evolve before `1.0`.
+
+## What it provides
+
+- application-scoped admin registry;
+- independent mount path, such as `/cabinet` or `/management`;
+- generic list, detail, form, and operation pages;
+- metric, table, list, and chart dashboard widgets;
+- async application-owned data providers;
+- permission checks for modules, pages, widgets, navigation, and actions;
+- overridable Jinja templates and packaged responsive CSS;
+- explicit module discovery without import-time registration side effects.
+
+## Installation
+
+```bash
+pip install codex-fastapi-cabinet
+```
+
+For local development:
+
+```bash
+uv sync --extra dev --extra docs
+```
+
+## Quick start
+
+```python
+from typing import ClassVar
+
+from fastapi import FastAPI, Request
+
+from fastapi_cabinet import (
+    CabinetAdmin,
+    CabinetProvider,
+    CabinetSite,
+    ListPage,
+    ListPageMap,
+    MetricWidget,
+    MetricWidgetMap,
+    SidebarItem,
+    TableColumnMap,
+    include_cabinet,
+)
+
+
+async def user_count(request: Request) -> MetricWidgetMap:
+    return MetricWidgetMap(
+        key="users-total",
+        title="Users",
+        value="42",
+        subtitle="Registered accounts",
+    )
+
+
+async def user_list(request: Request) -> ListPageMap:
+    return ListPageMap(
+        title="Users",
+        columns=[
+            TableColumnMap(key="email", label="Email"),
+            TableColumnMap(key="status", label="Status"),
+        ],
+        rows=[
+            {
+                "email": "admin@example.test",
+                "status": "active",
+                "href": "/management/users/1",
+            }
+        ],
+        row_href_key="href",
+    )
+
+
+class UsersAdmin(CabinetAdmin):
+    key = "users"
+    label = "Users"
+    sidebar = (SidebarItem(key="all", label="All users", path="all"),)
+    dashboard_widgets = (
+        MetricWidget(key="users-total", title="Users", provider="users.count"),
+    )
+    pages = (
+        ListPage(key="all", label="All users", path="all", provider="users.list"),
+    )
+    providers: ClassVar[dict[str, CabinetProvider]] = {
+        "users.count": user_count,
+        "users.list": user_list,
+    }
+
+
+app = FastAPI()
+site = CabinetSite(brand_name="My service")
+site.register(UsersAdmin)
+include_cabinet(app, site=site, mount_path="/management")
+```
+
+Run the complete example:
+
+```bash
+uvicorn examples.basic_app:app --reload
+```
+
+Then open `http://127.0.0.1:8000/management`.
+
+## Boundaries
+
+`codex-fastapi-cabinet` is a composition toolkit, not an ORM-aware CRUD generator. Providers return
+validated view models, so the same cabinet can sit over SQLAlchemy, another database layer, an HTTP
+API, or an in-memory service without coupling the library to any of them.
+
+The host application must secure the cabinet mount and provide real permission checks. The default
+permission provider allows every declared permission and is intended only when access control is
+enforced outside the library.
+
+## Documentation
+
+- [English documentation](docs/index.md)
+- [Русская документация](docs/ru/index.md)
+- [Architecture and extension boundaries](docs/architecture.md)
+- [Template customization](docs/customization.md)
+
+## Development
+
+```bash
+ruff check src tests examples
+mypy src tests examples
+pytest
+python -m build
+```
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).

codex_fastapi_cabinet-0.1.0/README.md

@@ -0,0 +1,140 @@
+# codex-fastapi-cabinet
+
+Composable, server-rendered administration interfaces for FastAPI sites and APIs.
+
+The library provides the management shell, routing, navigation, generic pages, dashboard widgets,
+permissions port, Jinja templates, and static assets. Your FastAPI application keeps ownership of
+authentication, authorization rules, database access, transactions, and business operations.
+
+> Status: alpha. The public API is usable, but may evolve before `1.0`.
+
+## What it provides
+
+- application-scoped admin registry;
+- independent mount path, such as `/cabinet` or `/management`;
+- generic list, detail, form, and operation pages;
+- metric, table, list, and chart dashboard widgets;
+- async application-owned data providers;
+- permission checks for modules, pages, widgets, navigation, and actions;
+- overridable Jinja templates and packaged responsive CSS;
+- explicit module discovery without import-time registration side effects.
+
+## Installation
+
+```bash
+pip install codex-fastapi-cabinet
+```
+
+For local development:
+
+```bash
+uv sync --extra dev --extra docs
+```
+
+## Quick start
+
+```python
+from typing import ClassVar
+
+from fastapi import FastAPI, Request
+
+from fastapi_cabinet import (
+    CabinetAdmin,
+    CabinetProvider,
+    CabinetSite,
+    ListPage,
+    ListPageMap,
+    MetricWidget,
+    MetricWidgetMap,
+    SidebarItem,
+    TableColumnMap,
+    include_cabinet,
+)
+
+
+async def user_count(request: Request) -> MetricWidgetMap:
+    return MetricWidgetMap(
+        key="users-total",
+        title="Users",
+        value="42",
+        subtitle="Registered accounts",
+    )
+
+
+async def user_list(request: Request) -> ListPageMap:
+    return ListPageMap(
+        title="Users",
+        columns=[
+            TableColumnMap(key="email", label="Email"),
+            TableColumnMap(key="status", label="Status"),
+        ],
+        rows=[
+            {
+                "email": "admin@example.test",
+                "status": "active",
+                "href": "/management/users/1",
+            }
+        ],
+        row_href_key="href",
+    )
+
+
+class UsersAdmin(CabinetAdmin):
+    key = "users"
+    label = "Users"
+    sidebar = (SidebarItem(key="all", label="All users", path="all"),)
+    dashboard_widgets = (
+        MetricWidget(key="users-total", title="Users", provider="users.count"),
+    )
+    pages = (
+        ListPage(key="all", label="All users", path="all", provider="users.list"),
+    )
+    providers: ClassVar[dict[str, CabinetProvider]] = {
+        "users.count": user_count,
+        "users.list": user_list,
+    }
+
+
+app = FastAPI()
+site = CabinetSite(brand_name="My service")
+site.register(UsersAdmin)
+include_cabinet(app, site=site, mount_path="/management")
+```
+
+Run the complete example:
+
+```bash
+uvicorn examples.basic_app:app --reload
+```
+
+Then open `http://127.0.0.1:8000/management`.
+
+## Boundaries
+
+`codex-fastapi-cabinet` is a composition toolkit, not an ORM-aware CRUD generator. Providers return
+validated view models, so the same cabinet can sit over SQLAlchemy, another database layer, an HTTP
+API, or an in-memory service without coupling the library to any of them.
+
+The host application must secure the cabinet mount and provide real permission checks. The default
+permission provider allows every declared permission and is intended only when access control is
+enforced outside the library.
+
+## Documentation
+
+- [English documentation](docs/index.md)
+- [Русская документация](docs/ru/index.md)
+- [Architecture and extension boundaries](docs/architecture.md)
+- [Template customization](docs/customization.md)
+
+## Development
+
+```bash
+ruff check src tests examples
+mypy src tests examples
+pytest
+python -m build
+```
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).

codex_fastapi_cabinet-0.1.0/docs/architecture.md

@@ -0,0 +1,48 @@
+# Architecture
+
+The package follows a small hexagonal composition model.
+
+## Kernel
+
+`contracts/`, `registry.py`, and `runtime.py` define stable declarations, validated render maps,
+registration, and URL rules. They do not know about a database, ORM, or concrete authentication
+system.
+
+## Application ports
+
+The host supplies:
+
+- providers that read data and return page/widget maps;
+- a permission provider implementing `can(request, permission)`;
+- action handlers that execute mutations;
+- optional dashboard context and sidebar badge values.
+
+These ports keep business behavior in the application where its transactions and policies live.
+
+## FastAPI and Jinja adapters
+
+`CabinetSite` composes the registry into FastAPI routes. Rendering mappers validate provider results
+before bundled Jinja templates receive them. `include_cabinet` mounts the router and packaged static
+assets.
+
+```text
+FastAPI request
+    -> CabinetSite route
+    -> permission port
+    -> host provider / action
+    -> validated page or widget map
+    -> Jinja adapter
+    -> HTML response
+```
+
+## Intentional non-goals
+
+- ORM model introspection;
+- implicit CRUD mutations;
+- owning user sessions or authentication;
+- replacing application services;
+- import-time global registration;
+- embedding game- or product-specific screens in the core package.
+
+Product-specific modules belong in the consuming project's frontend/admin package and use this
+library as their shared shell.

codex_fastapi_cabinet-0.1.0/docs/customization.md

@@ -0,0 +1,71 @@
+# Customization and security
+
+## Override templates
+
+Host template directories take precedence over package templates:
+
+```python
+site = CabinetSite(
+    brand_name="Internal tools",
+    template_directories=("src/my_project/templates",),
+)
+```
+
+To replace the detail page, create:
+
+```text
+src/my_project/templates/cabinet/pages/detail.html
+```
+
+You may also pass an existing FastAPI `Jinja2Templates` instance. Its loader remains available after
+the explicit override directories and before package defaults.
+
+## Permissions
+
+Implement the permission port:
+
+```python
+from fastapi import Request
+
+
+class ProjectPermissions:
+    async def can(self, request: Request, permission: str) -> bool:
+        actor = request.state.actor
+        return permission in actor.permissions
+```
+
+Then pass it to the site:
+
+```python
+site = CabinetSite(permission_provider=ProjectPermissions())
+```
+
+Permissions can be declared on modules, pages, widgets, sidebar items, and action routes. Hidden
+navigation is not a security boundary by itself; route access is checked separately.
+
+## Authentication and CSRF
+
+The host application must:
+
+- authenticate requests before they reach the cabinet;
+- protect the cabinet mount from anonymous access;
+- set `request.state.csrf_token` when forms require a CSRF token;
+- validate that token in mutation handlers or middleware;
+- authorize mutations again inside application use cases when appropriate.
+
+Bundled forms include the CSRF value as `csrf_token`. Non-POST semantic methods are also emitted as
+the `_method` field; if you use method tunnelling, install corresponding host middleware.
+
+## Static mount
+
+By default, assets are mounted at `<mount_path>/static`. Override this when assets are served
+elsewhere:
+
+```python
+include_cabinet(
+    app,
+    site=site,
+    mount_path="/management",
+    static_mount_path="/assets/cabinet",
+)
+```