florimondmanca / awesome-asgi

A curated list of awesome ASGI servers, frameworks, apps, libraries, and other resources

NOTICE

Now unused. See florimondmanca/www.

---

Personal

This is the repository for the frontend application powering my personal blog.

For the backend API, see personal-api.

Install

Install Angular CLI:

$ npm install -g @angular/cli

Install the dependencies:

$ npm install

Quickstart

Create an environment file called .env (it will be excluded from version control) at the project root, containing the following variables:

• API_KEY: a valid API key created via the backend admin site.
• BACKEND_URL: the URL to the backend root (without trailing slash).

For example:

# .env
API_KEY=myapikey
BACKEND_URL=http://localhost:8000

Generate your development environment file:

$ npm run config -- --env=dev

Start the development server, which will run on http://localhost:4200/:

$ ng serve -c dev

Using server-side rendering

Server side rendering is implemented using Angular Universal.

Server-side rendering allows to send fully-rendered HTML pages to clients, instead of sending them a blank page and letting Angular fill it in the browser. This reduces the "first meaningful paint" time, helps with referencing and allows integration with social media.

To use the server-rendered app, you must first create a build of the app:

$ npm run build:dev

Note: in production, use npm run build instead to create a production-optimized build.

Then start the server-rendered app (an Express server):

$ npm run serve:ssr

Scripts

See package.json for the available NPM scripts.

CI/CD

TravisCI is configured on this repo and generates a production build on every push to a branch.

awesome-asgi's Issues

reference a benchmark site ?

I found this site :
https://www.techempower.com/benchmarks/

with a clother look at Python only framework there:
https://www.techempower.com/benchmarks/#section=data-r18&hw=ph&test=fortune&l=zijzen-7

ASGI Benchmark

I guess this benchmark can be included here: https://github.com/klen/py-frameworks-bench/

On which section would be ideal? 🤔

Look into apatite

A cool project to check out sometime: https://github.com/mahmoud/apatite

Can generate the list in Markdown format from a YAML configuration file.

Also features tools to analyze listed repos.

Section categories

First, I just want to save thank you for creating this repo! It is really exciting to see how the ASGI ecosystem is progressing, and I think this will be a useful addition.

My issue relates to the sections, particularly the placement of Bonnette and Mangum. They are similar in usage to ASGI middleware (wrapping an application), but they actually provide adapter classes - not middleware.

Should these projects be listed under the "Libraries" section, or should there be a new section created labeled "Adapters"? I'd be happy to PR the changes based on discussion in this issue.

asgiref to ship type hints

Let's update the list with a note about asgiref containing reference type hints once those get merged and released.

Refs https://twitter.com/pdgjones/status/1342173442888658945
Refs django/asgiref#221

more frameworks and other stuff

hi @florimondmanca , please find some stuff I came by when looking at the environnement for a new project. If I'm not making a mistake I didnt see them here yet:

frameworks:
https://github.com/abersheeran/baize
https://github.com/starlite-api/starlite
https://github.com/adriangb/xpresso

di systems, not purely asgi related but those have integration with frameworks so worth mentionning imho:
https://github.com/meadsteve/lagom
https://github.com/adriangb/di

some goodies I'm using all the time, not sure where it fits in your classification:
https://github.com/alex-oleshkevich/starsessions
https://github.com/alex-oleshkevich/starception

add a release when README gets updated

Thanks for maintaining this awesome list. I'd like to suggest to add a release when a change is made to the README file. With this, we can watch the project without getting lots of activity emails.

Usage-centric classification

Discussion in #24 (comment) brought up to me that the categories in this list may not be optimal right now.

Eg. we have "applications", "libraries", and "middleware", and the separation between the three may not be clear enough.

If this list is aimed at promoting projects that help work with ASGI (i.e. mainly building web apps), then perhaps we could switch to a more use-case-centric classification, where each section is an answer to "how do I XYZ with ASGI?".

(We have this for "application frameworks" vs "servers", which respectively address "how do I build an ASGI web app" and "how do I serve it on the internet", and I think it works well.)

Dump of possible entries

A few entries worth considering for addition, discovered as part of working on #25:

• ASGI Documentation (Reference) -> Added via #34
• PrometheusMiddleware (Monitoring) -> Starlette-specific?
• EarlyDataMiddleware (Security) -> Apparent lack of adoption
• BugsnagMiddleware (Monitoring) -> Apparent lack of adoption
• Quick and dirty mock service with Starlette (Publications) -> #35

Other:

• broadcaster (Real-time Web) -> Probably better at awesome-asyncio

An ASGI toy example

Hi!
I wrote a very tiny ASGI web framework as an experiment and I thought maybe I could share it here. It is not for production usage of course but it could be useful as a learning resource to grasp the concept of how does ASGI work and to demystify how asyncio frameworks operate under the hood on a toy example. I'm not sure if it fits in this list so if it doesn't - please close this :)

Intro to ASGI spec PyconUS 2023 talk

Let’s consider adding @adriangb’d talk at PyConUS 2023 to this list once the replay’s out :)

« Inside your web framework: intro to the ASGI spec, middleware and apps »

https://twitter.com/pauloxnet/status/1649824653341499392

https://us.pycon.org/2023/schedule/presentation/5/

Integrate awesome asyncio

https://github.com/timofurrer/awesome-asyncio

Add vibora

https://github.com/vibora-io/vibora

ASGI middlewares

I have a couple experimental ASGI middlewares that are interesting at least from an academic standpoint/understanding how ASGI works. Should I make a PR to add them? Under what section?

• https://github.com/adriangb/asgi-routing (you folks might find https://github.com/adriangb/asgi-routing/blob/main/asgi_routing/_lifespan_dispatcher.py particularly amusing)
• https://github.com/adriangb/asgi-background
• https://github.com/adriangb/asgi-lifespan

Project proposal: ASGI profiling middleware using yappi

(Apologies in advance if this isn't an appropriate place to start a discussion like this!)

---

It looks like yappi support for coroutine profiling is just about complete: tiangolo/fastapi#701 (comment)

This should enable ASGI-compatible request-specific profiling (during development at least; yappi probably adds too much overhead to make sense during production). In particular, I think this could make it relatively easy to perform performance regression testing, etc.

If you look in that thread, you'll also see it can be used to display profiling info directly inside the browser. 🔥

---

I think it would be great if we could throw together a small ASGI middleware profiling package similar to the proposal from this comment, making use of the new yappi capabilities once they are released.

Eventually, I think it might make sense to try to package up functionality similar to what you'd expect from pytest --profile-svg in a non-asyncio context, as described in this comment.

---

If anyone is interested in collaborating on this let me know! I don't have experience publishing packages on PyPI so it would be great if someone more knowledgeable about that process could help out.