Skip to content

Commit 1ffc6b9

Browse files
committed
Improved README and AGENTS
1 parent dc38c8d commit 1ffc6b9

File tree

2 files changed

+11
-14
lines changed

2 files changed

+11
-14
lines changed

AGENTS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,15 @@ This repository provides a base library for building GraphQL servers across mult
1010
- `noxfile.py` holds automation sessions for linting and testing.
1111

1212
## Running Tests
13+
1314
Run the full test suite with:
1415

1516
```bash
1617
uv run pytest
1718
```
19+
20+
You can check the tests coverage by adding the `--cov` flag from `pytest-cov` when running `pytest`.
21+
22+
```bash
23+
uv run pytest --cov
24+
```

README.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
GraphQL-Server is a base library that serves as a helper
77
for building GraphQL servers or integrations into existing web frameworks using
88
[GraphQL-Core](https://github.com/graphql-python/graphql-core).
9+
* ✅ It passes all the GraphQL spec tests
10+
* Supports 💾 `Upload`s, 🔁 Sync, 🔀 Async views and 🔄 Subscriptions through WebSockets.
11+
* 🚀 It integrates seamlessly with all HTTP/Websocket Python servers
912

1013
## Integrations built with GraphQL-Server
1114

@@ -19,22 +22,9 @@ for building GraphQL servers or integrations into existing web frameworks using
1922
| FastAPI | [fastapi](https://github.com/graphql-python/graphql-server/blob/master/docs/fastapi.md) |
2023
| Flask | [flask](https://github.com/graphql-python/graphql-server/blob/master/docs/flask.md) |
2124
| Litestar | [litestar](https://github.com/graphql-python/graphql-server/blob/master/docs/litestar.md) |
22-
| WebOb | [webob](https://github.com/graphql-python/graphql-server/blob/master/docs/webob.md) |
2325
| Quart | [quart](https://github.com/graphql-python/graphql-server/blob/master/docs/quart.md) |
2426
| Sanic | [sanic](https://github.com/graphql-python/graphql-server/blob/master/docs/sanic.md) |
25-
26-
## Other integrations built with GraphQL-Server
27-
28-
| Server integration | Package |
29-
| ------------------ | ------------------------------------------------------------------------------------------------------- |
30-
| WSGI | [wsgi-graphql](https://github.com/moritzmhmk/wsgi-graphql) |
31-
| Responder | [responder.ext.graphql](https://github.com/kennethreitz/responder/blob/master/responder/ext/graphql.py) |
32-
33-
## Other integrations using GraphQL-Core or Graphene
34-
35-
| Server integration | Package |
36-
| ------------------ | --------------------------------------------------------------------- |
37-
| Django | [graphene-django](https://github.com/graphql-python/graphene-django/) |
27+
| WebOb | [webob](https://github.com/graphql-python/graphql-server/blob/master/docs/webob.md) |
3828

3929
## Documentation
4030

0 commit comments

Comments
 (0)