Skip to content

Commit 16e71de

Browse files
JacobCoffeeJacobCoffee
authored
docs: update readme (#17)
1 parent c274aff commit 16e71de

File tree

1 file changed

+37
-22
lines changed

1 file changed

+37
-22
lines changed

‎README.md‎

Lines changed: 37 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,34 @@
1-
# api-performance-tests
2-
3-
This is an API performance test comparing:
4-
1+
<!-- markdownlint-disable -->
52
<p align="center">
6-
<img src="https://github.com/starlite-api/branding/blob/9ab099a2089219c07727baaa29f67e9474ff93c8/assets/Starlite%20Branding%20-%20SVG%20-%20Transparent/Logo%20-%20Banner%20-%20Inline%20-%20Light.svg#gh-light-mode-only" alt="Starlite Logo - Light" width="100%" height="auto" />
7-
<img src="https://github.com/starlite-api/branding/blob/9ab099a2089219c07727baaa29f67e9474ff93c8/assets/Starlite%20Branding%20-%20SVG%20-%20Transparent/Logo%20-%20Banner%20-%20Inline%20-%20Dark.svg#gh-dark-mode-only" alt="Starlite Logo - Dark" width="100%" height="auto" />
3+
<img src="https://github.com/litestar-org/branding/blob/473f54621e55cde9acbb6fcab7fc03036173eb3d/assets/Branding%20-%20SVG%20-%20Transparent/Logo%20-%20Banner%20-%20Inline%20-%20Light.svg#gh-light-mode-only" alt="Litestar Logo - Light" width="100%" height="auto" />
4+
<img src="https://github.com/litestar-org/branding/blob/473f54621e55cde9acbb6fcab7fc03036173eb3d/assets/Branding%20-%20SVG%20-%20Transparent/Logo%20-%20Banner%20-%20Inline%20-%20Dark.svg#gh-dark-mode-only" alt="Litestar Logo - Dark" width="100%" height="auto" />
85
</p>
6+
<!-- markdownlint-restore -->
7+
8+
<div align="center">
9+
10+
<!-- prettier-ignore-start -->
911

10-
[![Discord](https://img.shields.io/discord/919193495116337154?color=202235&label=%20Discord&logo=discord)](https://discord.gg/X3FJqy8d2j) [![Matrix](https://img.shields.io/badge/%5Bm%5D%20Matrix-bridged-blue?color=202235)](https://matrix.to/#/#starlitespace:matrix.org) [![Reddit](https://img.shields.io/reddit/subreddit-subscribers/starlite?label=r%2FStarlite&logo=reddit)](https://reddit.com/r/starlite)
12+
| Project | | Status |
13+
|-----------|:----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
14+
| Community | | [![Reddit](https://img.shields.io/reddit/subreddit-subscribers/litestarapi?label=r%2FLitestar&logo=reddit&labelColor=202235&color=edb641&logoColor=edb641)](https://reddit.com/r/litestarapi) [![Discord](https://img.shields.io/discord/919193495116337154?labelColor=202235&color=edb641&label=chat%20on%20discord&logo=discord&logoColor=edb641)](https://discord.gg/X3FJqy8d2j) [![Matrix](https://img.shields.io/badge/chat%20on%20Matrix-bridged-202235?labelColor=202235&color=edb641&logo=matrix&logoColor=edb641)](https://matrix.to/#/#litestar:matrix.org) [![Medium](https://img.shields.io/badge/Medium-202235?labelColor=202235&color=edb641&logo=medium&logoColor=edb641)](https://blog.litestar.dev) [![Twitter](https://img.shields.io/twitter/follow/LitestarAPI?labelColor=202235&color=edb641&logo=twitter&logoColor=edb641&style=flat)](https://twitter.com/LitestarAPI) [![Blog](https://img.shields.io/badge/Blog-litestar.dev-202235?logo=blogger&labelColor=202235&color=edb641&logoColor=edb641)](https://blog.litestar.dev) |
15+
| Meta | | [![Litestar Project](https://img.shields.io/badge/Litestar%20Org-%E2%AD%90%20API%20Perf%20Tests-202235.svg?logo=python&labelColor=202235&color=edb641&logoColor=edb641)](https://github.com/litestar-org/litestar) [![License - MIT](https://img.shields.io/badge/license-MIT-202235.svg?logo=python&labelColor=202235&color=edb641&logoColor=edb641)](https://spdx.org/licenses/) [![Litestar Sponsors](https://img.shields.io/badge/Sponsor-%E2%9D%A4-%23edb641.svg?&logo=github&logoColor=edb641&labelColor=202235)](https://github.com/sponsors/litestar-org) [![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json&labelColor=202235)](https://github.com/astral-sh/ruff) [![code style - Black](https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&labelColor=202235&logoColor=edb641)](https://github.com/psf/black) |
1116

12-
1. [Starlite](https://github.com/starlite-api/starlite)
13-
2. [Starlette](https://github.com/encode/starlette)
14-
3. [FastAPI](https://github.com/tiangolo/fastapi)
15-
4. [Sanic](https://github.com/sanic-org/sanic)
16-
5. [BlackSheep](https://github.com/Neoteroi/BlackSheep)
17+
<!-- prettier-ignore-end -->
18+
</div>
19+
20+
# api-performance-tests
21+
22+
> **Note**
23+
> [**_Starlite has been renamed to Litestar_**](https://litestar.dev/about/organization.html#litestar-and-starlite)
24+
25+
This is an API performance test comparing:
26+
1. [Litestar](https://github.com/litestar-org/litestar)
27+
2. [Starlite v1.5x](https://github.com/litestar-org/litestar/tree/v1.51)
28+
3. [Starlette](https://github.com/encode/starlette)
29+
4. [FastAPI](https://github.com/tiangolo/fastapi)
30+
5. [Sanic](https://github.com/sanic-org/sanic)
31+
6. [BlackSheep](https://github.com/Neoteroi/BlackSheep)
1732

1833
Using the [bombardier](https://github.com/codesenberg/bombardier) HTTP benchmarking tool.
1934

@@ -60,7 +75,7 @@ Serializing a dictionary into JSON
6075

6176
##### Serialization
6277

63-
(only supported by `Starlite` and `FastAPI`)
78+
(only supported by `Litestar` and `FastAPI`)
6479

6580
- Serializing 50 dataclass objects each referencing 2 more dataclass objects
6681
- Serializing 100 dataclass objects each referencing 5 more dataclass objects
@@ -90,8 +105,8 @@ All responses return "No Content"
90105
(not supported by `Starlette`)
91106

92107
- Resolving 3 nested synchronous dependencies
93-
- Resolving 3 nested asynchronous dependencies (only supported by `Starlite` and `FastAPI`)
94-
- Resolving 3 nested synchronous, and 3 nested asynchronous dependencies (only supported by `Starlite` and `FastAPI`)
108+
- Resolving 3 nested asynchronous dependencies (only supported by `Litestar` and `FastAPI`)
109+
- Resolving 3 nested synchronous, and 3 nested asynchronous dependencies (only supported by `Litestar` and `FastAPI`)
95110

96111
#### Modifying responses
97112

@@ -120,25 +135,25 @@ After the run, the results will be stored in `results/run_<run_mumber>.json`
120135

121136
To select a framework, simply pass its name to the `run command`:
122137

123-
`bench run --rps starlite starlette fastapi`
138+
`bench run --rps litestar starlette fastapi`
124139

125140
##### Selecting a framework version
126141

127-
- A version available on PyPi: `bench run --rps starlite@v1.40.0`
128-
- A version from git: `bench run --rps starlite@git+branch_or_tag_name`
129-
- A version from a specific git repository: `bench run --rps starlite@git+https://github.com/starlite-api/starlite.git@branch_or_tag_name`
130-
- A local file: `bench run --rps starlite@file+/path/to/starlite`
142+
- A version available on PyPi: `bench run --rps litestar@v1.40.0`
143+
- A version from git: `bench run --rps litestar@git+branch_or_tag_name`
144+
- A version from a specific git repository: `bench run --rps litestar@git+https://github.com/litestar-org/litestar.git@branch_or_tag_name`
145+
- A local file: `bench run --rps litestar@file+/path/to/litestar`
131146

132147
#### Running a specific test
133148

134149
You can run a single test by specifying its full name and category:
135150

136-
`bench run --rps starlite -t json:json-1K`
151+
`bench run --rps litestar -t json:json-1K`
137152

138153
#### Test Settings
139154

140155
| | |
141-
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
156+
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
142157
| -r, --rebuild | rebuild docker images |
143158
| -L, --latency | run latency tests |
144159
| -R, --rps | run RPS tests |

0 commit comments

Comments
 (0)