Merge pull request #3 from qlient-org/dev

Test CI/CD with publish

Author: dfseifert

.circleci/config.yml

@@ -4,7 +4,7 @@ jobs:
 
   # Building and testing the project
   # Useful when a PR is open, for example
-  build-and-test:
+  test:
     # Our environment, Python 3.7
     docker:
       - image: circleci/python:3.7
@@ -44,8 +44,19 @@ jobs:
             python -m poetry run coverage run --omit="/home/circleci/.cache/pypoetry/virtualenvs" -m pytest
             python -m poetry run coverage report
 
+  # create the GitHub release
+  release:
+
+    # Same environment
+    docker:
+      - image: circleci/python:3.7
+
+    steps:
+      - checkout
+
+
   # This is the definition of another job, the one we use to publish the package to PyPI
-  deployment:
+  publish:
 
     # Same environment
     docker:
@@ -70,26 +81,24 @@ workflows:
   # The build-and-test we will run EVERYTIME a piece of code changes
   build-and-test-workflow:
     jobs:
-      - build-and-test
+      - test
 
     # The deployment workflow publishes the package
-  deployment-workflow:
+  release-and-publish:
     jobs:
-
-      # Runs build and test, but now just on Git tags (created from a GitHub release)
-      - build-and-test:
+      - release:
           filters:
-            tags:
-              only: /v[0-9]+(\.[0-9]+)*/
             branches:
-              ignore: /.*/
+              only: main
+
+      # Runs build and test, but now just on Git tags (created from a GitHub release)
+      - test
 
       # Runs the deployment job, just with the tags as well
-      - deployment:
+      - publish:
           requires:
-            - build-and-test
+            - release
+            - test
           filters:
-            tags:
-              only: /v[0-9]+(\.[0-9]+)*/
             branches:
-              ignore: /.*/
+              only: main

README.md

@@ -29,12 +29,26 @@ res = client.query.launchesPast(
     find={"mission_name": "Starlink"},
     limit=5,
     sort="mission_name",
-    
+
     # qlient specific
     _fields=["mission_name", "launch_success", "launch_year"]
 )
 ````
-`res` will look something like this.
+
+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": {

docs/index.md

@@ -11,51 +11,66 @@ A fast and modern graphql client designed with simplicity in mind.
 
 ## Quick Start
 
-```python
-from qlient import Client, Fields
+````python
+from qlient import Client
 
 client = Client("https://api.spacex.land/graphql/")
 
-mission_fields = Fields("mission_id", "mission_name")
-rocket_fields = Fields("rocket_name", fairings="ship")
+res = client.query.launchesPast(
+    # spacex graphql input fields
+    find={"mission_name": "Starlink"},
+    limit=5,
+    sort="mission_name",
 
-result = client.query.launchesPast(
-    limit=3,
-    _fields=Fields(mission_fields, rocket=rocket_fields)
+    # qlient specific
+    _fields=["mission_name", "launch_success", "launch_year"]
 )
-print(result)
+````
+
+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
+  }
+}
 ```
 
-```json
+to the server and return this body:
+
+````json
 {
   "data": {
     "launchesPast": [
       {
-        "mission_name": "Starlink-15 (v1.0)",
-        "rocket": {
-          "rocket_name": "Falcon 9",
-          "fairings": {
-            "ship": "GOMSCHIEF"
-          }
-        }
+        "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": "Sentinel-6 Michael Freilich",
-        "rocket": {
-          "rocket_name": "Falcon 9",
-          "fairings": {
-            "ship": null
-          }
-        }
+        "mission_name": "Starlink 3",
+        "launch_success": true,
+        "launch_year": "2020"
       },
       {
-        "mission_name": "Crew-1",
-        "rocket": {
-          "rocket_name": "Falcon 9",
-          "fairings": null
-        }
+        "mission_name": "Starlink 4",
+        "launch_success": true,
+        "launch_year": "2020"
       }
     ]
   }
 }
-```
+````

docs/install.md

@@ -1,7 +1,13 @@
 # Installation
 
-This package uses ``setuptools`` so it can be easily installed like so:
+This package is build with [poetry](https://python-poetry.org/) so installation is as you might expect.
 
+* **Using `pip`**
 ```shell
 pip install python-qlient
+```
+
+* **Using `poetry`**
+```shell
+poetry add python-qlient
 ```