pyganini 0.1.0__tar.gz

pyganini-0.1.0/LICENSE

@@ -0,0 +1,200 @@
+                                 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, 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 2026 Toly Pochkin.
+
+   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.

pyganini-0.1.0/PKG-INFO

@@ -0,0 +1,380 @@
+Metadata-Version: 2.4
+Name: pyganini
+Version: 0.1.0
+Summary: Server-first, HTML-first, HTMX-native Python web framework
+Author: Toly Pochkin
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Typing :: Typed
+Requires-Dist: anyio>=4.14.2,<4.15
+Requires-Dist: jinja2>=3.1.6,<4
+Requires-Dist: python-multipart>=0.0.32,<0.0.33
+Requires-Dist: starlette>=1.6.0,<1.7
+Requires-Python: >=3.13
+Project-URL: Homepage, https://github.com/mobiletoly/pyganini
+Project-URL: Repository, https://github.com/mobiletoly/pyganini
+Project-URL: Issues, https://github.com/mobiletoly/pyganini/issues
+Project-URL: Documentation, https://github.com/mobiletoly/pyganini/tree/main/docs/user
+Description-Content-Type: text/markdown
+
+# Pyganini
+
+[![CI](https://github.com/mobiletoly/pyganini/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/mobiletoly/pyganini/actions/workflows/ci.yml)
+[![Latest Release](https://img.shields.io/github/v/release/mobiletoly/pyganini?sort=semver)](https://github.com/mobiletoly/pyganini/releases/latest)
+[![License](https://img.shields.io/github/license/mobiletoly/pyganini?logo=apache&label=License)](LICENSE)
+
+Pyganini is a server-first Python web framework for HTML applications. You
+organize routes as Python packages, render Jinja templates, and use generated
+URL helpers instead of handwritten paths. Pyganini supports visible HTMX
+interactions while your application keeps control of Starlette or FastAPI,
+middleware, data access, and deployment.
+
+If Pyganini helps your project, please [star the repository](https://github.com/mobiletoly/pyganini).
+
+## Why Pyganini?
+
+Server-rendered applications often accumulate route tables, string URLs, and
+rendering conventions that drift apart. Pyganini derives those surfaces from
+one filesystem route tree.
+
+- Route packages keep handlers, templates, layouts, and middleware together.
+- Generation produces a deterministic Starlette router and typed URL helpers.
+- `pyganini check` catches stale generated files and invalid route source.
+- Jinja stays focused on HTML, including visible `hx-*` attributes.
+- Your application owns its server, middleware, sessions, persistence, and
+  deployment policy.
+
+Pyganini supports CPython 3.13 and newer.
+
+## Try a Complete App First
+
+The [full-feature example](examples/full_feature) is a contact directory with
+nested layouts, dynamic pages, forms, HTMX fragments, route kits, navigation,
+assets, browser helpers, and generated error pages.
+
+```text
+git clone https://github.com/mobiletoly/pyganini.git
+cd pyganini/examples/full_feature
+uv sync --locked --all-groups --python 3.14
+uv run --locked uvicorn app.main:app --host 127.0.0.1 --port 8000
+```
+
+Open [http://127.0.0.1:8000](http://127.0.0.1:8000).
+
+## Quick Start
+
+This small application serves one page through an application-owned Starlette
+host. Install Pyganini, Starlette, and Uvicorn in a new directory:
+
+```text
+mkdir hello-pyganini
+cd hello-pyganini
+mkdir -p app/routes
+touch app/__init__.py app/routes/__init__.py
+```
+
+Create `pyproject.toml`:
+
+```toml
+[project]
+name = "hello-pyganini"
+version = "0.0.0"
+requires-python = ">=3.13"
+dependencies = [
+    "pyganini==0.1.0",
+    "starlette>=1.6.0,<1.7",
+    "uvicorn>=0.52.4,<0.53",
+]
+
+[tool.pyganini]
+```
+
+Add the root route in `app/routes/route.py`:
+
+```python
+from pyganini import route
+
+from .handlers import page
+
+Route = route(page=page, template="page.jinja")
+```
+
+Return a page from `app/routes/handlers.py`:
+
+```python
+from pyganini import Page, PageMetadata
+from starlette.requests import Request
+
+from app._pyganini.urls import urls
+
+
+def page(_: Request) -> Page:
+    return Page(
+        context={"home_url": urls.root.path},
+        metadata=PageMetadata(title="Hello from Pyganini"),
+        layout={"product": "Pyganini"},
+    )
+```
+
+Add `app/routes/page.jinja`:
+
+```html
+<main>
+  <h1>Hello from Pyganini</h1>
+  <p>The generated URL for this page is <code>{{ home_url }}</code>.</p>
+</main>
+```
+
+Create an empty layout marker at `app/routes/layout.py`, then add
+`app/routes/layout.jinja`:
+
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>{{ metadata.title }}</title>
+  </head>
+  <body>
+    <header>{{ layout.product }}</header>
+    {{ child }}
+  </body>
+</html>
+```
+
+Mount the generated router from `app/main.py`:
+
+```python
+from starlette.applications import Starlette
+from starlette.routing import Mount
+
+from app._pyganini.asgi import router
+
+app = Starlette(routes=[Mount("/", app=router)])
+```
+
+Generate the router and URL helpers before importing `app.main`, then check and
+run the application:
+
+```text
+uv sync
+uv run pyganini generate
+uv run pyganini check
+uv run uvicorn app.main:app --host 127.0.0.1 --port 8000
+```
+
+Open [http://127.0.0.1:8000](http://127.0.0.1:8000). Continue with
+[Getting Started](docs/user/getting-started.md) to add a dynamic user page and
+inspect the generated route graph.
+
+## What Pyganini Gives You
+
+### Build pages from the filesystem
+
+Each package below `app/routes` maps to a URL segment. A route declaration
+connects a handler to its adjacent Jinja template. `layout.py` and
+`layout.jinja` mark layout ownership for that route subtree.
+
+### Generate checked application interfaces
+
+`pyganini generate` writes the router and typed URL tree below
+`app/_pyganini`. `pyganini check` rebuilds the expected bytes in memory and
+reports missing, stale, or invalid output without changing files.
+
+### Keep HTMX in the template
+
+Templates use ordinary `hx-get`, `hx-post`, `hx-target`, and `hx-swap`
+attributes. Generated URL values remove string paths without hiding the
+browser interaction.
+
+### Inspect before you run
+
+The CLI can list routes, show layout chains, explain one request path, find
+template route references, and report render units from source. These commands
+do not import application modules.
+
+### Own the application boundary
+
+Pyganini generates a Starlette router. Your application decides whether to
+serve it through Starlette or mount it in FastAPI. It also owns authentication,
+sessions, storage, middleware, static serving, and process management.
+
+## How Pyganini Apps Are Shaped
+
+A larger application can grow from the same route tree:
+
+```text
+pyproject.toml
+app/
+  __init__.py
+  main.py
+  routes/
+    __init__.py
+    route.py
+    handlers.py
+    layout.py
+    layout.jinja
+    page.jinja
+    users/
+      __init__.py
+      route.py
+      handlers.py
+      page.jinja
+      by_user_id/
+        __init__.py
+        route.py
+        handlers.py
+        page.jinja
+  shared/
+    reports/
+      __init__.py
+      page.jinja
+  _pyganini/
+    .pyganini-root
+    __init__.py
+    asgi.py
+    urls.py
+```
+
+Static package names map underscores to URL hyphens. A package named
+`by_user_id` creates `{user_id}` in the path. Each `route.py` contains one
+static `Route` declaration:
+
+```python
+from pyganini import action, fragment_route, route
+
+from .handlers import fragment_table, page, post_save
+
+Route = route(
+    page=page,
+    template="page.jinja",
+    fragments=(fragment_route("/table", fragment_table, template="table.jinja"),),
+    actions=(action("POST", "/save", post_save, template="form.jinja"),),
+)
+```
+
+Pyganini reads declarations without importing application code. Generation
+writes one live route graph for dispatch, URL helpers, checks, and inspection.
+Application code imports generated products after generation:
+
+```python
+from app._pyganini.asgi import router
+from app._pyganini.urls import urls
+
+user_path = urls.users.by_user_id("42").path
+```
+
+Pages inherit layouts from their route ancestry. Fragments render without page
+layouts. Route kits let several live route owners share typed handlers and
+templates while each owner keeps its path and URL surface. Mounted route
+subtrees provide filesystem-shaped reuse with explicit selection.
+
+Run source inspection from the application root:
+
+```text
+uv run pyganini routes list
+uv run pyganini routes layouts
+uv run pyganini routes explain /users/42
+uv run pyganini routes refs
+uv run pyganini routes render-units
+```
+
+The generated router can serve on its own or mount below Starlette or FastAPI.
+Pyganini runs asynchronous handlers on the event loop and synchronous handlers
+in an AnyIO worker thread.
+
+## More Examples
+
+- [Full-feature contact directory](examples/full_feature) combines the public
+  route, rendering, navigation, HTMX, asset, SSE, browser, and error surfaces.
+- [React island](examples/react_island) mounts one application-owned React
+  editor inside a server-rendered page.
+- [Svelte island](examples/svelte_island) mounts the same bounded interaction
+  with Svelte while keeping the server route model unchanged.
+
+## Documentation
+
+- [Getting Started](docs/user/getting-started.md) builds a two-page application
+  with a shared layout, a dynamic route, generated URL helpers, route
+  inspection, and an application-owned Starlette host.
+- [Installation](docs/user/installation.md) covers Python support, package
+  installation, runtime dependencies, and host ownership.
+- [Project layout](docs/user/project-layout.md) covers the application marker,
+  fixed source and generated paths, and file ownership.
+- [Command line](docs/user/cli.md) covers generation, non-writing checks, root
+  selection, output, diagnostics, and exit codes.
+- [Assets](docs/user/assets.md) covers final build projection, fingerprinted
+  output, generated lookup, commands, cleanup, host composition, and
+  development flow.
+- [Bounded client islands](docs/user/client-islands.md) covers explicit
+  application-owned roots, lifecycle cleanup, JSON policy, and build ownership.
+- [Route inspection](docs/user/route-inspection.md) covers source-only
+  declaration, implementation, navigation, mounted-selection, layout, and
+  error-render evidence.
+- [Routes](docs/user/routes.md) covers live route packages, declarations, path
+  mapping, layouts, and static validation.
+- [Route middleware](docs/user/middleware.md) covers live route-tree middleware,
+  ordering, mounted-owner scope, diagnostics, and host boundaries.
+- [Error composition](docs/user/errors.md) covers the optional generated-route
+  error callback, response contracts, and host ownership.
+- [Route kits](docs/user/route-kits.md) covers shared implementations, typed kit
+  values, owner-specific URLs, shared templates, and invocation boundaries.
+- [Mounted route subtrees](docs/user/mounted-routes.md) covers reusable
+  filesystem-shaped source trees, exact selection, owner-bound URLs, and
+  mounted layout order.
+- [Navigation](docs/user/navigation.md) covers request-local trails, dynamic
+  labels, typed destinations, alternate keys, Back, return safety, and mounted
+  ownership.
+- [Generated URL interfaces](docs/user/urls.md) covers typed route-shaped paths,
+  dynamic values, explicit base paths, and query and request-context
+  boundaries.
+- [Rendering and responses](docs/user/rendering.md) covers Jinja environments,
+  pages, layouts, fragments, render values, and direct Starlette responses.
+- [Server-Sent Event helpers](docs/user/sse.md) covers UTF-8 wire framing,
+  comments, reconnection headers, Starlette streaming, and application-owned
+  operational policy.
+- [Browser helpers](docs/user/browser.md) covers the optional fixed-resource
+  app, named SSE event swaps, template overlay delivery, explicit mounting,
+  and cache revalidation.
+- [Template inspection](docs/user/template-inspection.md) covers typed
+  development modes, render markers, explicit Jinja call blocks, and the
+  optional browser overlay.
+- [HTMX and async forms](docs/user/htmx.md) covers visible attributes, generated
+  URL values, header helpers, Starlette form parsing, uploads, and validation.
+- [CSRF helpers](docs/user/csrf.md) covers the optional signed-cookie helper,
+  visible form and HTMX values, validation ordering, and application-owned
+  policy.
+
+## Contributing
+
+The repository uses uv 0.12.3 and Python 3.14 for development while retaining
+Python 3.13 compatibility:
+
+```text
+uv python install 3.13 3.14
+uv lock --check
+uv sync --locked --all-groups --python 3.14
+uv run --locked --python 3.14 ruff format --check .
+uv run --locked --python 3.14 ruff check .
+uv run --locked --python 3.14 mypy src/pyganini
+uv run --locked --python 3.14 pyright src/pyganini
+uv run --locked --python 3.14 pytest -q tests/test_csrf_typing.py tests/test_sse_typing.py tests/test_assets.py::test_generated_asset_consumers_are_checked_by_both_type_checkers
+uv run --locked --python 3.14 pytest
+uv sync --locked --all-groups --python 3.13
+uv run --locked --python 3.13 pytest
+```
+
+Maintainer architecture records live under [`docs/arch`](docs/arch). The
+[release guide](docs/releasing.md) records candidate and trusted-publisher
+steps.
+
+## License
+
+Pyganini is licensed under the [Apache License 2.0](LICENSE).