diff --git a/README.md b/README.md index b4da32199..3cf8c6119 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,7 @@ Let Piccolo scaffold you an ASGI web app, using Piccolo as the ORM: piccolo asgi new ``` -[Starlette](https://www.starlette.io/), [FastAPI](https://fastapi.tiangolo.com/), [BlackSheep](https://www.neoteroi.dev/blacksheep/), [Litestar](https://litestar.dev/), [Esmerald](https://esmerald.dev/), [Lilya](https://lilya.dev), [Quart](https://quart.palletsprojects.com/en/latest/), [Falcon](https://falconframework.org/) and [Sanic](https://sanic.dev/en/) are currently supported. +[Starlette](https://www.starlette.io/), [FastAPI](https://fastapi.tiangolo.com/), [BlackSheep](https://www.neoteroi.dev/blacksheep/), [Litestar](https://litestar.dev/), [Ravyn](https://www.ravyn.dev/), [Lilya](https://lilya.dev/), [Quart](https://quart.palletsprojects.com/en/latest/), [Falcon](https://falconframework.org/) and [Sanic](https://sanic.dev/en/) are currently supported. ## Piccolo ecosystem diff --git a/docs/src/index.rst b/docs/src/index.rst index 849694a21..82b6bd690 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -60,7 +60,7 @@ Give me an ASGI web app! piccolo asgi new -FastAPI, Starlette, BlackSheep, Litestar, Esmerald, Lilya, Quart, Falcon and Sanic +FastAPI, Starlette, BlackSheep, Litestar, Ravyn, Lilya, Quart, Falcon and Sanic are currently supported, with more coming soon. ---------------------------------------------------------------------------------- diff --git a/docs/src/piccolo/asgi/index.rst b/docs/src/piccolo/asgi/index.rst index a0756ca6f..a05c75874 100644 --- a/docs/src/piccolo/asgi/index.rst +++ b/docs/src/piccolo/asgi/index.rst @@ -22,7 +22,7 @@ Routing frameworks `Starlette `_, `FastAPI `_, `BlackSheep `_, -`Litestar `_, `Esmerald `_, +`Litestar `_, `Ravyn `_, `Lilya `_, `Quart `_, `Falcon `_ @@ -31,8 +31,8 @@ and `Sanic `_ are supported. Which to use? ============= -All are great choices. FastAPI is built on top of Starlette and Esmerald is built on top of Lilya, so they're -very similar. FastAPI, BlackSheep, Litestar and Esmerald are great if you want to document a REST +All are great choices. FastAPI is built on top of Starlette and Ravyn is built on top of Lilya, so they're +very similar. FastAPI, BlackSheep, Litestar and Ravyn are great if you want to document a REST API, as they have built-in OpenAPI support. ------------------------------------------------------------------------------- diff --git a/piccolo/apps/asgi/commands/new.py b/piccolo/apps/asgi/commands/new.py index 673de9af9..f85b7b980 100644 --- a/piccolo/apps/asgi/commands/new.py +++ b/piccolo/apps/asgi/commands/new.py @@ -14,7 +14,7 @@ "fastapi": ["fastapi"], "blacksheep": ["blacksheep[full]"], "litestar": ["litestar"], - "esmerald": ["esmerald"], + "ravyn": ["ravyn"], "lilya": ["lilya"], "quart": ["quart", "quart_schema"], "falcon": ["falcon"], diff --git a/piccolo/apps/asgi/commands/templates/app/_esmerald_app.py.jinja b/piccolo/apps/asgi/commands/templates/app/_ravyn_app.py.jinja similarity index 96% rename from piccolo/apps/asgi/commands/templates/app/_esmerald_app.py.jinja rename to piccolo/apps/asgi/commands/templates/app/_ravyn_app.py.jinja index 3556eba14..ad9cc3407 100644 --- a/piccolo/apps/asgi/commands/templates/app/_esmerald_app.py.jinja +++ b/piccolo/apps/asgi/commands/templates/app/_ravyn_app.py.jinja @@ -1,9 +1,9 @@ from typing import Any from pathlib import Path -from esmerald import ( +from ravyn import ( APIView, - Esmerald, + Ravyn, Gateway, HTTPException, Include, @@ -12,7 +12,7 @@ from esmerald import ( post, put, ) -from esmerald.core.config import StaticFilesConfig +from ravyn.core.config import StaticFilesConfig from piccolo.engine import engine_finder from piccolo.utils.pydantic import create_pydantic_model from piccolo_admin.endpoints import create_admin @@ -107,7 +107,7 @@ class TaskAPIView(APIView): await task.remove() -app = Esmerald( +app = Ravyn( routes=[ Gateway("/", handler=home), Gateway("/tasks", handler=TaskAPIView), diff --git a/piccolo/apps/asgi/commands/templates/app/app.py.jinja b/piccolo/apps/asgi/commands/templates/app/app.py.jinja index a4bf71ee2..9e22c8f28 100644 --- a/piccolo/apps/asgi/commands/templates/app/app.py.jinja +++ b/piccolo/apps/asgi/commands/templates/app/app.py.jinja @@ -6,8 +6,8 @@ {% include '_blacksheep_app.py.jinja' %} {% elif router == 'litestar' %} {% include '_litestar_app.py.jinja' %} -{% elif router == 'esmerald' %} - {% include '_esmerald_app.py.jinja' %} +{% elif router == 'ravyn' %} + {% include '_ravyn_app.py.jinja' %} {% elif router == 'lilya' %} {% include '_lilya_app.py.jinja' %} {% elif router == 'quart' %} diff --git a/piccolo/apps/asgi/commands/templates/app/home/_esmerald_endpoints.py.jinja b/piccolo/apps/asgi/commands/templates/app/home/_ravyn_endpoints.py.jinja similarity index 82% rename from piccolo/apps/asgi/commands/templates/app/home/_esmerald_endpoints.py.jinja rename to piccolo/apps/asgi/commands/templates/app/home/_ravyn_endpoints.py.jinja index a8c9bfdff..0a400c3df 100644 --- a/piccolo/apps/asgi/commands/templates/app/home/_esmerald_endpoints.py.jinja +++ b/piccolo/apps/asgi/commands/templates/app/home/_ravyn_endpoints.py.jinja @@ -1,8 +1,8 @@ import os import jinja2 -from esmerald import Request, Response, get -from esmerald.responses import HTMLResponse +from ravyn import Request, Response, get +from ravyn.responses import HTMLResponse ENVIRONMENT = jinja2.Environment( loader=jinja2.FileSystemLoader( diff --git a/piccolo/apps/asgi/commands/templates/app/home/endpoints.py.jinja b/piccolo/apps/asgi/commands/templates/app/home/endpoints.py.jinja index 4f0023134..21c3903ab 100644 --- a/piccolo/apps/asgi/commands/templates/app/home/endpoints.py.jinja +++ b/piccolo/apps/asgi/commands/templates/app/home/endpoints.py.jinja @@ -4,8 +4,8 @@ {% include '_blacksheep_endpoints.py.jinja' %} {% elif router == 'litestar' %} {% include '_litestar_endpoints.py.jinja' %} -{% elif router == 'esmerald' %} - {% include '_esmerald_endpoints.py.jinja' %} +{% elif router == 'ravyn' %} + {% include '_ravyn_endpoints.py.jinja' %} {% elif router == 'lilya' %} {% include '_lilya_endpoints.py.jinja' %} {% elif router == 'quart' %} diff --git a/piccolo/apps/asgi/commands/templates/app/home/templates/home.html.jinja_raw b/piccolo/apps/asgi/commands/templates/app/home/templates/home.html.jinja_raw index 47cb9a039..f5e447a9b 100644 --- a/piccolo/apps/asgi/commands/templates/app/home/templates/home.html.jinja_raw +++ b/piccolo/apps/asgi/commands/templates/app/home/templates/home.html.jinja_raw @@ -56,7 +56,7 @@
  • Admin
  • Swagger API
  • -

    Esmerald

    +

    Ravyn