anyquart 0.1.0__tar.gz

anyquart-0.1.0/LICENSE.txt

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright 2017 Pallets
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

anyquart-0.1.0/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: anyquart
+Version: 0.1.0
+Summary: A fork of Quart that uses AnyIO
+Author-email: pgjones <philip.graham.jones@googlemail.com>, NIYONSHUTI Emmanuel <emmanuelniyonshuti13@gmail.com>
+Maintainer-email: NIYONSHUTI Emmanuel <emmanuelniyonshuti13@gmail.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-Expression: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Flask
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Typing :: Typed
+License-File: LICENSE.txt
+Requires-Dist: anyio>=4.14.0,<5
+Requires-Dist: blinker>=1.6
+Requires-Dist: click>=8.0
+Requires-Dist: flask>=3.0
+Requires-Dist: anycorn>=0.11.2
+Requires-Dist: importlib-metadata; python_version < '3.13'
+Requires-Dist: itsdangerous
+Requires-Dist: jinja2
+Requires-Dist: markupsafe
+Requires-Dist: typing-extensions; python_version < '3.13'
+Requires-Dist: werkzeug>=3.0
+Requires-Dist: python-dotenv ; extra == "dotenv"
+Project-URL: Documentation, https://quart.palletsprojects.com
+Project-URL: Donate, https://palletsprojects.com/donate
+Project-URL: Source, https://github.com/EmmanuelNiyonshuti/anyquart
+Provides-Extra: dotenv
+
+# AnyQuart
+
+Quart runs on Asyncio and when you want to run it on Trio event loop you use [quart-trio](https://github.com/pgjones/quart-trio) extension.
+
+AnyQuart is [Quart](https://github.com/pallets/quart) running on [AnyIO](https://github.com/agronholm/anyio). It is a fork of Quart 0.20.1.
+
+All credit for Quart goes to the [Pallets](https://palletsprojects.com) team.
+
+## Usage
+You will have to replace `quart` with `anyquart` and `Quart` with `AnyQuart`.
+
+Install from PyPI using an installer such as pip. Requires Python 3.10+.
+
+```
+$ pip install anyquart
+```
+
+Save the following as `app.py`.
+
+```python
+from anyquart import AnyQuart, websocket, render_template
+
+app = AnyQuart(__name__)
+
+@app.route("/")
+async def hello():
+    return await render_template("index.html")
+
+@app.route("/api")
+async def json():
+    return {"hello": "world"}
+
+@app.websocket("/ws")
+async def ws():
+    while True:
+        await websocket.send("hello")
+        await websocket.send_json({"hello": "world"})
+```
+
+```
+$ anyquart run
+ * Running on http://127.0.0.1:5000 (CTRL + C to quit)
+```
+
+# Testing
+Pytest does not natively support async test functions hence we need an async framework for async tests and fixtures.
+Quart uses pytest-asyncio, here we use AnyIO's pytest plugin. You will need to specify which backend your tests run on via the `anyio_backend` fixture and decorate your asynchronous tests with `@pytest.mark.anyio`.
+
+```python
+import pytest
+
+from app import app
+
+@pytest.fixture()
+def anyio_backend():
+    return "trio" # you can replace with "asyncio"
+
+@pytest.fixture()
+def test_client():
+    return app.test_client()
+
+@pytest.mark.anyio
+async def test_do_something(test_client) -> None:
+    response = await test_client.get("/")
+    assert response.status_code == 200
+    assert await response.json == {"hello": "world"}
+
+```
+
+## Differences from Quart
+- Uses [Anycorn](https://github.com/davidbrochart/anycorn) instead of Hypercorn as the development server
+- Works with both asyncio and Trio via AnyIO
+- Uses AnyIO's file I/O instead of aiofiles
+- AnyIO primitives work freely in route handlers, giving you structured concurrency out of the box
+- Tests need `@pytest.mark.anyio` and the `anyio_backend` fixture instead of pytest-asyncio
+
+Refer to the [Quart documentation](https://quart.palletsprojects.com) for more details.
+

anyquart-0.1.0/README.md

@@ -0,0 +1,77 @@
+# AnyQuart
+
+Quart runs on Asyncio and when you want to run it on Trio event loop you use [quart-trio](https://github.com/pgjones/quart-trio) extension.
+
+AnyQuart is [Quart](https://github.com/pallets/quart) running on [AnyIO](https://github.com/agronholm/anyio). It is a fork of Quart 0.20.1.
+
+All credit for Quart goes to the [Pallets](https://palletsprojects.com) team.
+
+## Usage
+You will have to replace `quart` with `anyquart` and `Quart` with `AnyQuart`.
+
+Install from PyPI using an installer such as pip. Requires Python 3.10+.
+
+```
+$ pip install anyquart
+```
+
+Save the following as `app.py`.
+
+```python
+from anyquart import AnyQuart, websocket, render_template
+
+app = AnyQuart(__name__)
+
+@app.route("/")
+async def hello():
+    return await render_template("index.html")
+
+@app.route("/api")
+async def json():
+    return {"hello": "world"}
+
+@app.websocket("/ws")
+async def ws():
+    while True:
+        await websocket.send("hello")
+        await websocket.send_json({"hello": "world"})
+```
+
+```
+$ anyquart run
+ * Running on http://127.0.0.1:5000 (CTRL + C to quit)
+```
+
+# Testing
+Pytest does not natively support async test functions hence we need an async framework for async tests and fixtures.
+Quart uses pytest-asyncio, here we use AnyIO's pytest plugin. You will need to specify which backend your tests run on via the `anyio_backend` fixture and decorate your asynchronous tests with `@pytest.mark.anyio`.
+
+```python
+import pytest
+
+from app import app
+
+@pytest.fixture()
+def anyio_backend():
+    return "trio" # you can replace with "asyncio"
+
+@pytest.fixture()
+def test_client():
+    return app.test_client()
+
+@pytest.mark.anyio
+async def test_do_something(test_client) -> None:
+    response = await test_client.get("/")
+    assert response.status_code == 200
+    assert await response.json == {"hello": "world"}
+
+```
+
+## Differences from Quart
+- Uses [Anycorn](https://github.com/davidbrochart/anycorn) instead of Hypercorn as the development server
+- Works with both asyncio and Trio via AnyIO
+- Uses AnyIO's file I/O instead of aiofiles
+- AnyIO primitives work freely in route handlers, giving you structured concurrency out of the box
+- Tests need `@pytest.mark.anyio` and the `anyio_backend` fixture instead of pytest-asyncio
+
+Refer to the [Quart documentation](https://quart.palletsprojects.com) for more details.

anyquart-0.1.0/pyproject.toml

@@ -0,0 +1,211 @@
+[project]
+name = "anyquart"
+version = "0.1.0"
+description = "A fork of Quart that uses AnyIO"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE.txt"]
+authors = [
+    { name = "pgjones", email = "philip.graham.jones@googlemail.com" },
+    { name = "NIYONSHUTI Emmanuel", email = "emmanuelniyonshuti13@gmail.com" }
+    ]
+maintainers = [{ name = "NIYONSHUTI Emmanuel", email = "emmanuelniyonshuti13@gmail.com" }]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "Framework :: Flask",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Typing :: Typed",
+]
+requires-python = ">=3.10"
+dependencies = [
+    "anyio>=4.14.0,<5",
+    "blinker>=1.6",
+    "click>=8.0",
+    "flask>=3.0",
+    "anycorn>=0.11.2",
+    "importlib-metadata; python_version < '3.13'",
+    "itsdangerous",
+    "jinja2",
+    "markupsafe",
+    "typing-extensions; python_version < '3.13'",
+    "werkzeug>=3.0",
+]
+
+[project.urls]
+Donate = "https://palletsprojects.com/donate"
+Documentation = "https://quart.palletsprojects.com"
+Source = "https://github.com/EmmanuelNiyonshuti/anyquart"
+
+[project.optional-dependencies]
+dotenv = ["python-dotenv"]
+
+[project.scripts]
+anyquart = "anyquart.cli:main"
+
+[dependency-groups]
+dev = [
+    "trio==0.33.0",
+    "ruff",
+    "tox",
+    "tox-uv",
+]
+
+gha-update = [
+    "gha-update ; python_full_version >= '3.12'",
+]
+pre-commit = [
+    "pre-commit",
+    "pre-commit-uv",
+]
+tests = [
+    "hypothesis",
+    "pytest",
+    "pytest-cov",
+    "pytest-sugar",
+    "python-dotenv",
+]
+typing = [
+    "mypy",
+    "pyright",
+    "pytest",
+]
+
+[build-system]
+requires = ["flit-core<4"]
+build-backend = "flit_core.buildapi"
+
+[tool.flit.module]
+name = "anyquart"
+
+[tool.uv]
+default-groups = ["dev", "pre-commit", "tests", "typing"]
+
+[tool.pytest.ini_options]
+addopts = "--no-cov-on-fail --showlocals --strict-markers"
+testpaths = ["tests"]
+filterwarnings = [
+    "error",
+]
+
+[tool.coverage.run]
+branch = true
+source = ["anyquart", "tests"]
+
+[tool.coverage.paths]
+source = ["src", "*/site-packages"]
+
+[tool.coverage.report]
+exclude_also = [
+    "if t.TYPE_CHECKING",
+    "raise NotImplementedError",
+    ": \\.{3}",
+]
+
+[tool.mypy]
+python_version = "3.10"
+files = ["src", "tests"]
+show_error_codes = true
+pretty = true
+strict = true
+# TODO fully satisfy strict mode and remove these customizations
+allow_redefinition = true
+disallow_any_generics = false
+disallow_untyped_calls = false
+implicit_reexport = true
+no_implicit_optional = true
+strict_optional = false
+warn_return_any = false
+
+[tool.pyright]
+pythonVersion = "3.10"
+include = ["src", "tests"]
+typeCheckingMode = "basic"
+
+[tool.ruff]
+src = ["src"]
+fix = true
+show-fixes = true
+output-format = "full"
+
+[tool.ruff.lint]
+select = [
+    "B",  # flake8-bugbear
+    "E",  # pycodestyle error
+    "F",  # pyflakes
+    "FA",  # flake8-future-annotations
+    "I",  # isort
+    "N",  # pep8-naming
+    "UP",  # pyupgrade
+    "W",  # pycodestyle warning
+]
+ignore = [
+    "UP038",  # keep isinstance tuple
+    "UP007",  # Union[] is needed for forward-referenced type aliases
+    "UP045"
+]
+
+[tool.ruff.lint.isort]
+force-single-line = true
+order-by-type = false
+
+[tool.tox]
+env_list = [
+    "py3.14", "py3.13", "py3.12", "py3.11", "py3.10",
+    "style",
+    "typing",
+    "docs",
+]
+
+[tool.tox.env_run_base]
+description = "pytest on latest dependency versions"
+runner = "uv-venv-lock-runner"
+package = "wheel"
+wheel_build_env = ".pkg"
+constrain_package_deps = true
+use_frozen_constraints = true
+dependency_groups = ["tests", "dev"]
+commands = [[
+    "pytest", "-v", "--tb=short", "--basetemp={env_tmp_dir}", "--cov=anyquart",
+    {replace = "posargs", default = [], extend = true},
+]]
+
+[tool.tox.env.style]
+description = "run all pre-commit hooks on all files"
+dependency_groups = ["pre-commit"]
+skip_install = true
+commands = [["pre-commit", "run", "--all-files"]]
+
+[tool.tox.env.typing]
+description = "run static type checkers"
+dependency_groups = ["tests", "typing"]
+commands = [
+    ["mypy"],
+]
+
+
+[tool.tox.env.update-actions]
+description = "update GitHub Actions pins"
+labels = ["update"]
+dependency_groups = ["gha-update"]
+skip_install = true
+commands = [["gha-update"]]
+
+[tool.tox.env.update-pre_commit]
+description = "update pre-commit pins"
+labels = ["update"]
+dependency_groups = ["pre-commit"]
+skip_install = true
+commands = [["pre-commit", "autoupdate", "--freeze", "-j4"]]
+
+[tool.tox.env.update-requirements]
+description = "update uv lock"
+labels = ["update"]
+dependency_groups = []
+no_default_groups = true
+skip_install = true
+commands = [["uv", "lock", {replace = "posargs", default = ["-U"], extend = true}]]

anyquart-0.1.0/src/anyquart/__init__.py

@@ -0,0 +1,55 @@
+from __future__ import annotations
+
+from markupsafe import escape as escape
+from markupsafe import Markup as Markup
+
+from .app import AnyQuart as AnyQuart
+from .blueprints import Blueprint as Blueprint
+from .config import Config as Config
+from .ctx import after_this_request as after_this_request
+from .ctx import copy_current_app_context as copy_current_app_context
+from .ctx import copy_current_request_context as copy_current_request_context
+from .ctx import copy_current_websocket_context as copy_current_websocket_context
+from .ctx import has_app_context as has_app_context
+from .ctx import has_request_context as has_request_context
+from .ctx import has_websocket_context as has_websocket_context
+from .globals import current_app as current_app
+from .globals import g as g
+from .globals import request as request
+from .globals import session as session
+from .globals import websocket as websocket
+from .helpers import abort as abort
+from .helpers import flash as flash
+from .helpers import get_flashed_messages as get_flashed_messages
+from .helpers import get_template_attribute as get_template_attribute
+from .helpers import make_push_promise as make_push_promise
+from .helpers import make_response as make_response
+from .helpers import redirect as redirect
+from .helpers import send_file as send_file
+from .helpers import send_from_directory as send_from_directory
+from .helpers import stream_with_context as stream_with_context
+from .helpers import url_for as url_for
+from .json import jsonify as jsonify
+from .signals import appcontext_popped as appcontext_popped
+from .signals import appcontext_pushed as appcontext_pushed
+from .signals import appcontext_tearing_down as appcontext_tearing_down
+from .signals import before_render_template as before_render_template
+from .signals import got_request_exception as got_request_exception
+from .signals import got_websocket_exception as got_websocket_exception
+from .signals import message_flashed as message_flashed
+from .signals import request_finished as request_finished
+from .signals import request_started as request_started
+from .signals import request_tearing_down as request_tearing_down
+from .signals import signals_available as signals_available
+from .signals import template_rendered as template_rendered
+from .signals import websocket_finished as websocket_finished
+from .signals import websocket_started as websocket_started
+from .signals import websocket_tearing_down as websocket_tearing_down
+from .templating import render_template as render_template
+from .templating import render_template_string as render_template_string
+from .templating import stream_template as stream_template
+from .templating import stream_template_string as stream_template_string
+from .typing import ResponseReturnValue as ResponseReturnValue
+from .wrappers import Request as Request
+from .wrappers import Response as Response
+from .wrappers import Websocket as Websocket

anyquart-0.1.0/src/anyquart/__main__.py

@@ -0,0 +1,6 @@
+from __future__ import annotations
+
+if __name__ == "__main__":
+    from .cli import main
+
+    main()