gramlot-py-server 0.2.1__tar.gz

gramlot_py_server-0.2.1/.gitignore

@@ -0,0 +1,13 @@
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.coverage
+coverage.xml
+htmlcov/
+docs/_build/
+build/
+dist/
+*.egg-info/
+.venv/
+
+.DS_Store

gramlot_py_server-0.2.1/LICENSE

@@ -0,0 +1,176 @@
+                                 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 the 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

gramlot_py_server-0.2.1/NOTICE

@@ -0,0 +1,8 @@
+Gramlot Uvicorn
+Copyright 2026 Softwell S.r.l.
+
+This product includes software developed at Softwell S.r.l.
+(https://www.softwell.it/). It is an adapter for Gramlot,
+Copyright 2025-2026 Softwell S.r.l., Apache License 2.0.
+
+Licensed under the Apache License, Version 2.0.

gramlot_py_server-0.2.1/PKG-INFO

@@ -0,0 +1,266 @@
+Metadata-Version: 2.5
+Name: gramlot-py-server
+Version: 0.2.1
+Summary: Python server adapters for Gramlot pages: Uvicorn, Django, Flask, FastAPI and Kajenn
+Project-URL: Homepage, https://github.com/gramlot-org/gramlot-py-server
+Project-URL: Repository, https://github.com/gramlot-org/gramlot-py-server
+Project-URL: Issues, https://github.com/gramlot-org/gramlot-py-server/issues
+Project-URL: Documentation, https://gramlot-py-server.readthedocs.io/
+Author-email: Genropy Team <info@softwell.it>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.11
+Requires-Dist: gramlot>=0.2.1
+Provides-Extra: django
+Requires-Dist: asgiref<4,>=3.8.1; extra == 'django'
+Requires-Dist: django<6.2,>=5.2; extra == 'django'
+Provides-Extra: docs
+Requires-Dist: myst-parser==5.1.0; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme==3.1.0; extra == 'docs'
+Requires-Dist: sphinx==8.2.3; extra == 'docs'
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.115; extra == 'fastapi'
+Provides-Extra: flask
+Requires-Dist: flask<4,>=3.1; extra == 'flask'
+Provides-Extra: kajenn
+Requires-Dist: kajenn>=0.1.0; extra == 'kajenn'
+Provides-Extra: test
+Requires-Dist: genro-tytx[msgpack]; extra == 'test'
+Requires-Dist: httpx>=0.27; extra == 'test'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'test'
+Requires-Dist: pytest-cov>=4.0; extra == 'test'
+Requires-Dist: pytest>=7.0; extra == 'test'
+Provides-Extra: uvicorn
+Requires-Dist: uvicorn>=0.30; extra == 'uvicorn'
+Description-Content-Type: text/markdown
+
+# gramlot-py-server
+
+[![tests](https://github.com/gramlot-org/gramlot-py-server/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/gramlot-org/gramlot-py-server/actions/workflows/tests.yml)
+[![Coverage](https://codecov.io/gh/gramlot-org/gramlot-py-server/branch/main/graph/badge.svg)](https://app.codecov.io/gh/gramlot-org/gramlot-py-server)
+[![Documentation](https://readthedocs.org/projects/gramlot-py-server/badge/?version=latest)](https://gramlot-py-server.readthedocs.io/en/latest/)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue)](LICENSE)
+
+Gramlot describes web interfaces in Python or JavaScript and keeps them bound to
+application state in the browser. See
+[The Gramlot family](https://gramlot.readthedocs.io/en/latest/docs/public/055-family.html)
+for the core and the other repositories.
+
+## What this repository is
+
+`gramlot-py-server` serves Gramlot pages written in Python from a Python web
+server. One package holds one adapter per framework; each comes with its extra:
+
+| Extra | Module | Names |
+| --- | --- | --- |
+| `uvicorn` | `gramlot_py_server.uvicorn` | `Application`, `create_application(pages, **options)`: an ASGI application for Uvicorn or any ASGI server |
+| `django` | `gramlot_py_server.django` | `Pages`: its `urls` go into a URLconf |
+| `flask` | `gramlot_py_server.flask` | `Pages`, `mount_pages(app, pages, **options)` |
+| `fastapi` | `gramlot_py_server.fastapi` | `Pages`, `mount_pages(app, pages, **options)`, `Application` |
+| `kajenn` | `gramlot_py_server.kajenn` | `Application`: a Kajenn routed application |
+
+Every adapter serves one folder of `Page` modules through the core `FileHost`:
+it sends the bootstrap document, answers the main and remote Source requests,
+serves the page companions (`.css` and `_aux.js`) and the browser runtime, with
+a mount prefix and a Content Security Policy of your choice. It does not serve
+JavaScript pages
+([gramlot-js-server](https://github.com/gramlot-org/gramlot-js-server) does)
+and it does not talk to a database.
+
+## Quick start
+
+Python 3.11 or later. Install the package with the extra of your framework:
+
+```sh
+python -m pip install "gramlot-py-server[uvicorn]"
+```
+
+Create a folder `pages` and write `pages/hello.py`:
+
+```python
+from gramlot import Page as BasePage
+
+
+class Page(BasePage):
+    title = "Hello"
+
+    def main(self, root):
+        pane = root.div(datapath="person")
+        pane.html_label("Name", for_="name")
+        pane.input(id="name", value="^.name", live=True)
+        pane.p("^.greeting")
+        pane.dataFormula(".greeting", "'Hello, ' + name", name="^.name", _init=True)
+        pane.dataSetter(".name", "Ada")
+```
+
+The formula of this page is inline code, so every example below sends the
+permissive Content Security Policy profile. Each one lives in
+[`examples/`](examples/), beside a folder `pages`; the docstring of each file
+gives the command that starts it. The page opens at
+<http://127.0.0.1:8000/hello>, on port 5000 for the Flask development server.
+FastAPI needs a server: install `gramlot-py-server[fastapi,uvicorn]`.
+
+Uvicorn, `examples/uvicorn/app.py`:
+
+```python
+"""Serve the example pages with Uvicorn: ``uvicorn app:application``."""
+from pathlib import Path
+
+from gramlot_py_server.uvicorn import create_application
+
+PAGES = Path(__file__).resolve().parents[1] / "pages"
+
+application = create_application(
+    PAGES,
+    content_security_policy="script-src 'nonce-{nonce}' 'unsafe-eval'; object-src 'none'; base-uri 'none'",
+)
+```
+
+Django, `examples/django/settings.py` and `examples/django/urls.py`:
+
+```python
+"""Django settings of the example: ``django-admin runserver --settings=settings --pythonpath=.``."""
+
+SECRET_KEY = "example-only-change-me"
+DEBUG = True
+ALLOWED_HOSTS = ["127.0.0.1", "localhost", "testserver"]
+ROOT_URLCONF = "urls"
+INSTALLED_APPS: list[str] = []
+MIDDLEWARE = ["django.middleware.csrf.CsrfViewMiddleware"]
+```
+
+```python
+"""URLconf of the example: the Gramlot pages at the site root."""
+from pathlib import Path
+
+from django.urls import include, path
+
+from gramlot_py_server.django import Pages
+
+PAGES = Path(__file__).resolve().parents[1] / "pages"
+
+pages = Pages(
+    PAGES,
+    content_security_policy="script-src 'nonce-{nonce}' 'unsafe-eval'; object-src 'none'; base-uri 'none'",
+)
+
+urlpatterns = [path("", include(pages.urls))]
+```
+
+Flask, `examples/flask/app.py`:
+
+```python
+"""Serve the example pages inside a Flask app: ``flask --app app run``."""
+from pathlib import Path
+
+from flask import Flask
+
+from gramlot_py_server.flask import mount_pages
+
+PAGES = Path(__file__).resolve().parents[1] / "pages"
+
+app = Flask(__name__)
+mount_pages(
+    app,
+    PAGES,
+    content_security_policy="script-src 'nonce-{nonce}' 'unsafe-eval'; object-src 'none'; base-uri 'none'",
+)
+```
+
+FastAPI, `examples/fastapi/app.py`:
+
+```python
+"""Serve the example pages inside a FastAPI app: ``fastapi dev app.py`` or ``uvicorn app:app``."""
+from pathlib import Path
+
+from fastapi import FastAPI
+
+from gramlot_py_server.fastapi import mount_pages
+
+PAGES = Path(__file__).resolve().parents[1] / "pages"
+
+app = FastAPI()
+mount_pages(
+    app,
+    PAGES,
+    content_security_policy="script-src 'nonce-{nonce}' 'unsafe-eval'; object-src 'none'; base-uri 'none'",
+)
+```
+
+Kajenn, `examples/kajenn/config.py` (the page opens at
+<http://127.0.0.1:8000/pages/hello>):
+
+```python
+"""Kajenn site of the example: ``kajenn serve config.py --port 8000``, pages under ``/pages``."""
+from pathlib import Path
+
+from kajenn.config.templates import DefaultConfiguration
+
+from gramlot_py_server.kajenn import Application
+
+PAGES = Path(__file__).resolve().parents[1] / "pages"
+
+
+class Site(DefaultConfiguration):
+    def applications_section(self, cfg):
+        cfg.applications().application(
+            code="pages",
+            mount="pages",
+            app_class=Application,
+            pages=PAGES,
+            content_security_policy=(
+                "script-src 'nonce-{nonce}' 'unsafe-eval'; object-src 'none'; base-uri 'none'"
+            ),
+        ).request(body="raw")
+```
+
+The page shows a field with `Ada` and the text `Hello, Ada`. Typing `Grace` in
+the field changes the text to `Hello, Grace` at every keystroke. The tests
+`tests/<framework>/test_<framework>_examples.py` serve these examples in CI, and
+`tests/test_readme.py` checks that this README shows the same files.
+
+## Next steps
+
+- The guides on Read the Docs, sources in [docs/](docs/) and the concise view
+  in [docs_llm/](docs_llm/):
+  - common: [Introduction](https://gramlot-py-server.readthedocs.io/en/latest/005-introduction.html),
+    [Writing pages for these hosts](https://gramlot-py-server.readthedocs.io/en/latest/010-writing-pages.html),
+    [Troubleshooting](https://gramlot-py-server.readthedocs.io/en/latest/015-troubleshooting.html);
+  - Uvicorn: [Tutorial](https://gramlot-py-server.readthedocs.io/en/latest/105-tutorial.html),
+    [Configuration](https://gramlot-py-server.readthedocs.io/en/latest/110-configuration.html),
+    [Deployment](https://gramlot-py-server.readthedocs.io/en/latest/115-deployment.html),
+    [Reference](https://gramlot-py-server.readthedocs.io/en/latest/120-reference.html);
+  - [Django](https://gramlot-py-server.readthedocs.io/en/latest/205-django.html), [Flask](https://gramlot-py-server.readthedocs.io/en/latest/305-flask.html),
+    [FastAPI](https://gramlot-py-server.readthedocs.io/en/latest/405-fastapi.html), [Kajenn](https://gramlot-py-server.readthedocs.io/en/latest/505-kajenn.html).
+- The core: [The Gramlot family](https://gramlot.readthedocs.io/en/latest/docs/public/055-family.html),
+  [Classes, repository and server adapters](https://gramlot.readthedocs.io/en/latest/docs/public/090-classes-and-hosts.html)
+  (the shared adapter contract: mount prefix, companions, CSP profiles),
+  [Writing pages](https://gramlot.readthedocs.io/en/latest/docs/public/095-writing-pages.html).
+
+## Compatibility
+
+| | Verified |
+| --- | --- |
+| Gramlot core | 0.2.1 (PyPI `gramlot`) |
+| Python | 3.11 and 3.12 in CI; 3.12.12 locally |
+| Frameworks | Uvicorn 0.54.0, Django 6.1.1 with asgiref 3.12.1, Flask 3.1.3, FastAPI 0.142.2, Kajenn 0.1.0 |
+| Browsers | not run for this package; the core runtime it serves, unchanged since 0.2.0, passed the core 0.2.0 qualification on Chromium 153, WebKit 26.6 and Firefox 155 |
+
+## Tests and contributing
+
+```sh
+python -m pip install -e ".[uvicorn,django,flask,fastapi,kajenn,test]"
+python -m pytest -q                      # every adapter
+python -m pytest -q tests/flask          # one adapter, with its extra only
+python scripts/check_docs.py             # paired guides and Sphinx build
+```
+
+CI runs each adapter with its own extra against the released core and, as an
+informational job, every adapter against the core's `main` checkout, and builds
+the documentation; coverage goes to Codecov with one flag per framework. See
+[CONTRIBUTING.md](CONTRIBUTING.md) and [AGENTS.md](AGENTS.md); the internal
+notes are in [docs/internal/](docs/internal/).
+
+Apache License 2.0. Copyright 2026 Softwell S.r.l. See [LICENSE](LICENSE) and
+[NOTICE](NOTICE).