Skip to content

Commit c837438

Browse files
committed
updates updates
1 parent a81b683 commit c837438

File tree

14 files changed

+47
-34
lines changed

14 files changed

+47
-34
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,7 @@ test.graphql
44
**/.idea/tasks.xml
55
schemagen/**/__pycache__/
66
schemagen/**/**/__pycache__/
7-
.DS_store
7+
.DS_store
8+
schemagen.egg-info
9+
build
10+
dist

.idea/graphene_graphql_sdl_parser.iml

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,19 @@ class User(ObjectType):
5656
```
5757

5858
# Notes
59-
SchemaGen is currently in its first version so there are some things you need to know:
59+
Here are some things you should know about using SchemaGen:
60+
* SchemaGen is not guaranteed to catch errors in your GraphQL schema file.
61+
62+
SchemaGen will only catch a very small percentage of errors that might occur in defining a GraphQL schema.
63+
It is the developer's responsibility to ensure the GraphQL schema file is error-free.
64+
65+
66+
* SchemaGen will not install the graphene package on your local machine however it will import it in the generated python file.
67+
68+
You can easily install the package by running:
69+
```shell
70+
pip install graphene
71+
```
6072
* GraphQL type declarations in your schema file **must be ordered**.
6173

6274
Because of the way Python and SchemaGen works, you cannot use a GraphQL type
@@ -108,7 +120,7 @@ SchemaGen is currently in its first version so there are some things you need to
108120
}
109121
```
110122

111-
We plan to fix these issues in the future. Pull requests are welcome!
123+
I plan to fix the last two issues stated above in the future. Pull requests are welcome!
112124

113125

114126

-7.29 KB
Binary file not shown.
-706 Bytes
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)