Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jhnnsrs/turms
Turms is a pure python implementation of the awesome graphql-codegen library, following a simliar extensible design.
https://github.com/jhnnsrs/turms
graphql pydantic python
Last synced: 4 days ago
JSON representation
Turms is a pure python implementation of the awesome graphql-codegen library, following a simliar extensible design.
- Host: GitHub
- URL: https://github.com/jhnnsrs/turms
- Owner: jhnnsrs
- License: mit
- Created: 2022-01-20T11:04:02.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-20T09:26:05.000Z (16 days ago)
- Last Synced: 2024-09-20T09:40:09.635Z (16 days ago)
- Topics: graphql, pydantic, python
- Language: Python
- Homepage: https://jhnnsrs.github.io/turms/
- Size: 1.97 MB
- Stars: 60
- Watchers: 2
- Forks: 16
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Funding: FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-pydantic - turms - GraphQL code generator that generates pydantic models from GraphQL documents (Web)
- awesome-pydantic - turms - GraphQL code generator that generates pydantic models from GraphQL documents (Web)
README
# turms
[](https://codecov.io/gh/jhnnsrs/turms)
[](https://pypi.org/project/turms/)
[](https://pypi.org/project/turms/)
[](https://pypi.python.org/pypi/turms/)
[](https://pypi.python.org/pypi/turms/)
[](https://pypi.python.org/pypi/turms/)
## Goal
Turms is a `graphql-codegen` inspired code generator for python that generates typed and serializable python code from your graphql schema and documents. Just define your query in standard graphql syntax and let turms create fully typed queries/mutation and subscriptions, that you can use in your favourite IDE.
Turms allows you to easily generate both server-side and client-side code for your GraphQL API.
### Schema (Server) Generation:
Can generate the following types from your graphql SDL schema:
- Enums
- Inputs
- Objects
- Scalars
- Directives
Sepcific generation supported for:
- [x] Strawberry
- [ ] Graphene
### Documents (Client) Generation
Can generate the following pydantic models from your graphql documents:
- Enums
- Inputs
- Scalars
- Fragments
- Operations
## Features
- Fully typed, fully documented code generation
- Schema and Document based code generation
- Compatible with popular graphql libraries (strawberry, gql, rath, etc.)
- Support for custom scalars, custom directives, ...
- Powerful plugin system (e.g. custom Linting, custom formatting, etc.)
- Operation functions like query, mutation, subscription (e.g. `data= get_capsules()`)
- Compliant with graphl-config
- Code migration support (trying to merge updates into existing code)
## Installation
```bash
pip install turms
```
turms is a pure development library and will not introduce any dependency on itself into your
code, so we recommend installing turms as a development dependency.
```bash
poetry add -D turms
```
As of now turms only supports python 3.9 and higher (as we rely on ast unparsing)
## Configuration
Turms relies on and complies with [graphql-config](https://www.graphql-config.com/docs/user/user-introduction) and searches your current working dir for the graphql-config file.
### Document based generation
Based on pydantic models
```yaml
projects:
default:
schema: http://api.spacex.land/graphql/
documents: graphql/**.graphql
extensions:
turms: # path for configuration for turms
out_dir: examples/api
plugins: # path for plugin configuration
- type: turms.plugins.enums.EnumsPlugin
- type: turms.plugins.inputs.InputsPlugin
- type: turms.plugins.fragments.FragmentsPlugin
- type: turms.plugins.operation.OperationsPlugin
- type: turms.plugins.funcs.FuncsPlugin
processors:
- type: turms.processor.black.BlackProcessor
- type: turms.processor.isort.IsortProcessor
scalar_definitions:
uuid: str
timestamptz: str
Date: str
```
### Schema based generation
Based on strawberry models
```yaml
projects:
default:
schema: beasts.graphql
extensions:
turms:
skip_forwards: true
out_dir: api
stylers:
- type: turms.stylers.capitalize.CapitalizeStyler
- type: turms.stylers.snake_case.SnakeCaseStyler
plugins:
- type: turms.plugins.strawberry.StrawberryPlugin # generates a strawberry schema
processors:
- type: turms.processors.disclaimer.DisclaimerProcessor
- type: turms.processors.black.BlackProcessor
- type: turms.processors.isort.IsortProcessor
- type: turms.processors.merge.MergeProcessor # merges the formated schema with already defined functions
scalar_definitions:
uuid: str
_Any: typing.Any
```
### Usage
Once you have configured turms you can generate your code by running
```bash
turms gen
```
### Why Turms
In Etruscan religion, Turms (usually written as 𐌕𐌖𐌓𐌌𐌑 Turmś in the Etruscan alphabet) was the equivalent of Roman Mercury and Greek Hermes, both gods of trade and the **messenger** god between people and gods.
## Transport Layer
Turms does _not_ come with a default transport layer but if you are searching for an Apollo-like GraphQL Client you can check out [rath](https://github.com/jhnnsrs/rath), that works especially well with turms.
## Examples
This github repository also contains some examples on how to use turms with popular libraries in the graphql ecosystem.