Skip to content
This repository was archived by the owner on Jun 8, 2025. It is now read-only.
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/asgi.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

BlackSheep belongs to the category of
[ASGI](https://asgi.readthedocs.io/en/latest/) web frameworks, so it requires
an ASGI HTTP server to run, such as [uvicorn](http://www.uvicorn.org/), or
[hypercorn](https://pgjones.gitlab.io/hypercorn/). All examples in this
an ASGI HTTP server to run, such as [uvicorn](http://www.uvicorn.org/),
[hypercorn](https://pgjones.gitlab.io/hypercorn/) or
[granian](https://github.com/emmett-framework/granian). All examples in this
documentation use `Uvicorn`, but the framework has been tested also with
`Hypercorn` and should work with any server that implements ASGI.

Expand Down
7 changes: 4 additions & 3 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,10 @@ and activate it:
BlackSheep belongs to the category of
[ASGI](https://asgi.readthedocs.io/en/latest/) web frameworks, therefore it
requires an ASGI HTTP server to run, such as
[uvicorn](http://www.uvicorn.org/), or
[hypercorn](https://pgjones.gitlab.io/hypercorn/). For this tutorial, install
`uvicorn` together with `blacksheep`:
[uvicorn](http://www.uvicorn.org/),
[hypercorn](https://pgjones.gitlab.io/hypercorn/) or
[granian](https://github.com/emmett-framework/granian).
For this tutorial, install `uvicorn` together with `blacksheep`:

```bash
pip install blacksheep uvicorn
Expand Down
5 changes: 3 additions & 2 deletions docs/websocket.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ chat apps, etc.

BlackSheep is able to handle incoming WebSocket connections if you're using
an ASGI server that supports WebSocket protocol
(for example [Uvicorn](https://www.uvicorn.org/#quickstart)
or [Hypercorn](https://pgjones.gitlab.io/hypercorn/)).
(for example [Uvicorn](https://www.uvicorn.org/#quickstart),
[Hypercorn](https://pgjones.gitlab.io/hypercorn/) or
[Granian](https://github.com/emmett-framework/granian)).

## Creating a WebSocket route

Expand Down