Merge pull request #23 from qlient-org/develop

Pre-Release 0.1.0-alpha

Author: dfseifert

.gitignore

@@ -7,5 +7,4 @@
 /.pytest_cache/**
 /*.egg-info/
 .install.stamp
-.coverage
-/site/**
+.coverage

Makefile

@@ -11,6 +11,7 @@ help:
 	@echo " clean		remove all temporary files"
 	@echo " test		run all the tests"
 	@echo " report		print coverage report"
+	@echo " docs		create the docs"
 	@echo " shell		open a Poetry shell"
 
 
@@ -23,7 +24,7 @@ $(INSTALL_STAMP): pyproject.toml
 .PHONY: clean
 clean:
 	find . -type d -name "__pycache__" | xargs rm -rf {};
-	rm -rf $(INSTALL_STAMP) .coverage .mypy_cache
+	rm -rf $(INSTALL_STAMP) .coverage .mypy_cache .pytest_cache
 	rm -rf build
 	rm -rf dist
 
@@ -36,6 +37,10 @@ test: $(INSTALL_STAMP)
 report: $(INSTALL_STAMP)
 	$(POETRY) run coverage report
 
+.PHONY: docs
+docs: $(INSTALL_STAMP)
+	$(POETRY) run mkdocs build
+
 
 .PHONY: shell
 shell: $(INSTALL_STAMP)

README.md

@@ -1,8 +1,8 @@
 # Qlient: Python GraphQL Client
 
 [![qlient-org](https://circleci.com/gh/qlient-org/python-qlient.svg?style=svg)](https://circleci.com/gh/qlient-org/python-qlient)
-[![pypi](https://img.shields.io/pypi/v/python-qlient.svg)](https://pypi.python.org/pypi/python-qlient)
-[![versions](https://img.shields.io/pypi/pyversions/python-qlient.svg)](https://github.com/qlient-org/python-qlient)
+[![pypi](https://img.shields.io/pypi/v/qlient.svg)](https://pypi.python.org/pypi/qlient)
+[![versions](https://img.shields.io/pypi/pyversions/qlient.svg)](https://github.com/qlient-org/python-qlient)
 [![license](https://img.shields.io/github/license/qlient-org/python-qlient.svg)](https://github.com/qlient-org/python-qlient/blob/master/LICENSE)
 
 A fast and modern graphql client designed with simplicity in mind.
@@ -20,65 +20,19 @@ pip install qlient
 ## Quick Start
 
 ````python
-from qlient import Client
+from qlient import Client, GraphQLResponse
 
-client = Client("https://api.spacex.land/graphql/")
+client = Client("https://swapi-graphql.netlify.app/.netlify/functions/index")
 
-res = client.query.launchesPast(
-    # spacex graphql input fields
-    find={"mission_name": "Starlink"},
-    limit=5,
-    sort="mission_name",
+res: GraphQLResponse = client.query.film(
+    # swapi graphql input fields
+    id="ZmlsbXM6MQ==",
 
     # qlient specific
-    _fields=["mission_name", "launch_success", "launch_year"]
+    _fields=["id", "title", "episodeID"]
 )
-````
-
-which sends the following query
-
-```gql
-query launchesPast($find: LaunchFind, $limit: Int, $sort: String) {
-  launchesPast(find: $find, limit: $limit, sort: $sort) {
-    mission_name
-    launch_success
-    launch_year
-  }
-}
-```
-
-to the server and return this body:
 
-````json
-{
-  "data": {
-    "launchesPast": [
-      {
-        "mission_name": "Paz / Starlink Demo",
-        "launch_success": true,
-        "launch_year": "2018"
-      },
-      {
-        "mission_name": "Starlink 1",
-        "launch_success": true,
-        "launch_year": "2019"
-      },
-      {
-        "mission_name": "Starlink 2",
-        "launch_success": true,
-        "launch_year": "2020"
-      },
-      {
-        "mission_name": "Starlink 3",
-        "launch_success": true,
-        "launch_year": "2020"
-      },
-      {
-        "mission_name": "Starlink 4",
-        "launch_success": true,
-        "launch_year": "2020"
-      }
-    ]
-  }
-}
-````
+print(res.query)  # query film($id: ID) { film(id: $id) { id title episodeID } }
+print(res.variables)  # {'id': 'ZmlsbXM6MQ=='}
+print(res.data)  # {'film': {'id': 'ZmlsbXM6MQ==', 'title': 'A New Hope', 'episodeID': 4}}
+````

docs/examples/.graphqlconfig

@@ -0,0 +1,12 @@
+{
+  "name": "SWAPI GraphQL API",
+  "schemaPath": "swapi-schema.graphql",
+  "extensions": {
+    "endpoints": {
+      "Default GraphQL Endpoint": {
+        "url": "https://swapi-graphql.netlify.app/.netlify/functions/index",
+        "introspect": true
+      }
+    }
+  }
+}

docs/examples/custom_schema_provider.py

@@ -0,0 +1,16 @@
+from typing import Dict
+
+from qlient import Client, Schema
+from qlient.schema.providers import SchemaProvider
+
+
+class MySchemaProvider(SchemaProvider):
+
+    def load_schema(self) -> Dict:
+        # do some logic that loads your schema
+        return {...}
+
+
+my_schema = Schema(provider=MySchemaProvider())
+
+client = Client("https://...", schema=my_schema)

docs/examples/full_settings.py

@@ -0,0 +1,9 @@
+from qlient import Settings, Client
+
+my_settings = Settings(
+    introspect=True,  # default, enable backend schema introspection
+    validate_fields=True,  # default, enable query field selection validation
+    validate_variables=True  # default, enable query variable validation
+)
+
+my_client = Client("https://...", settings=my_settings)

docs/examples/index_quick_start.py

@@ -0,0 +1,15 @@
+from qlient import Client, GraphQLResponse
+
+client = Client("https://swapi-graphql.netlify.app/.netlify/functions/index")
+
+res: GraphQLResponse = client.query.film(
+    # swapi graphql input fields
+    id="ZmlsbXM6MQ==",
+
+    # qlient specific
+    _fields=["id", "title", "episodeID"]
+)
+
+print(res.query)  # query film($id: ID) { film(id: $id) { id title episodeID } }
+print(res.variables)  # {'id': 'ZmlsbXM6MQ=='}
+print(res.data)  # {'film': {'id': 'ZmlsbXM6MQ==', 'title': 'A New Hope', 'episodeID': 4}}

docs/examples/project_batches.md

@@ -0,0 +1,4 @@
+[![qlient-org](https://circleci.com/gh/qlient-org/python-qlient.svg?style=svg)](https://circleci.com/gh/qlient-org/python-qlient)
+[![pypi](https://img.shields.io/pypi/v/qlient.svg)](https://pypi.python.org/pypi/qlient)
+[![versions](https://img.shields.io/pypi/pyversions/qlient.svg)](https://github.com/qlient-org/python-qlient)
+[![license](https://img.shields.io/github/license/qlient-org/python-qlient.svg)](https://github.com/qlient-org/python-qlient/blob/master/LICENSE)

docs/examples/read_schema_from_local_path.py

@@ -0,0 +1,10 @@
+from pathlib import Path
+
+from qlient import Client, Schema
+from qlient.schema.providers import FileSchemaProvider
+
+path_to_schema = Path("./path/to/my/schema.json")
+
+local_schema = Schema(provider=FileSchemaProvider(path_to_schema))
+
+client = Client("https://...", schema=local_schema)

docs/examples/request_with_nested_fields.py

@@ -0,0 +1,16 @@
+from qlient import Client, Fields
+
+client: Client = Client("https://swapi-graphql.netlify.app/.netlify/functions/index")
+
+nested_fields = Fields(
+    people=Fields(
+        "id",
+        "name",
+        homeworld="name"
+    )
+)
+
+response = client.query.allPeople(first=3, _fields=nested_fields)
+
+print(response.query)
+# query allPeople($first: Int) { allPeople(first: $first) { people { id name homeworld { name } } } }