Skip to content

Commit

Permalink
docs: make the readme more succinct and quicker to understand
Browse files Browse the repository at this point in the history
  • Loading branch information
BeatsuDev authored Sep 15, 2024
1 parent 8989d99 commit bfa05d3
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# gqlrequests - Create requests to GraphQL APIs with no strings attached 😉
# gqlrequests - Build GraphQL query-strings automagically

### ✅ Create queries from pydantic models
### ✅ Create queries from annotated classes
### ✅ Dynamically select query fields

______
[![Pytests and Coverage](https://github.com/BeatsuDev/GraphQLRequests/actions/workflows/testing_and_coverage.yml/badge.svg)](https://github.com/BeatsuDev/GraphQLRequests/actions/workflows/testing_and_coverage.yml)
[![Code Quality](https://github.com/BeatsuDev/GraphQLRequests/actions/workflows/code_quality.yml/badge.svg)](https://github.com/BeatsuDev/GraphQLRequests/actions/workflows/code_quality.yml)
[![codecov](https://codecov.io/gh/BeatsuDev/GraphQLRequests/branch/main/graph/badge.svg?token=FBQKU5OEWT)](https://codecov.io/gh/BeatsuDev/GraphQLRequests)

Define GraphQL types in Python as classes or pydantic classes, then use them to automatically build queries. Or even simpler;
gqlrequests will automatically build the classes for you given the api endpoint by using introspection! (Now that's awesome).
You no longer need to define your requests as multiline strings (hence no strings attached).
A dynamic, pythonic way to build queries instead of using large multiline strings.

## Examples of currently working features:

Expand Down Expand Up @@ -109,3 +112,5 @@ print(Character)
# }
#
```

### ✅ Query validation while developing in your IDE

0 comments on commit bfa05d3

Please sign in to comment.