Merge pull request #32 from qlient-org/develop

BREAKING CHANGE: Release 1.0.0

Author: qlient-org

.circleci/config.yml

@@ -1,11 +1,15 @@
 version = 1
 
 test_patterns = ["tests/**"]
+exclude_patterns = ["docs/**", "site/**"]
 
 [[analyzers]]
 name = "python"
 enabled = true
 
   [analyzers.meta]
-  max_line_length = 120
   runtime_version = "3.x.x"
+
+[[transformers]]
+name = "black"
+enabled = true

.deepsource.toml

@@ -0,0 +1,30 @@
+name: Qlient HTTP Requests - Docs
+
+on:
+  push:
+    branches:
+    - main
+
+jobs:
+  build_and_push:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+      - name: Set up Poetry
+        uses: abatilo/[email protected]
+        with:
+          poetry-version: 1.1.13
+      - name: Install dependencies
+        run: poetry install
+      - name: Build And Commit Site
+        run: |
+          poetry run mkdocs build
+          git config user.name github-actions
+          git config user.email [email protected]
+          git add site
+          git commit -m "ci: build and commit documentation"
+          git push

.github/workflows/docs.yml

@@ -0,0 +1,23 @@
+name: Qlient HTTP Requests - Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build_and_publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+      - name: Set up Poetry
+        uses: abatilo/[email protected]
+        with:
+          poetry-version: 1.1.13
+      - name: Install dependencies
+        run: poetry install
+      - name: Publish
+        run: poetry publish --build --username "${{secrets.PYPI_USERNAME}}" --password "${{secrets.PYPI_PASSWORD}}" --no-interaction

.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Qlient HTTP Requests - Pytest
+
+on: [push]
+
+jobs:
+  test:
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        poetry-version: ["1.1.13"]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Set up Poetry ${{ matrix.poetry-version }}
+        uses: abatilo/[email protected]
+        with:
+          poetry-version: ${{ matrix.poetry-version }}
+      - name: Install dependencies
+        run: poetry install
+      - name: Run Pytest
+        run: poetry run pytest --cov=src --cov-report=xml

.github/workflows/pytest.yml

@@ -1,10 +1,82 @@
-/venv/
-/env/
-/virtualenv/
-/.idea/
-/build/
-/dist/
-/.pytest_cache/**
-/*.egg-info/
-.install.stamp
-.coverage
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# IPython
+profile_default/
+ipython_config.py
+
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+.idea/
+
+# install stamp
+.install.stamp

.gitignore

@@ -30,7 +30,7 @@ clean:
 
 .PHONY: test
 test: $(INSTALL_STAMP)
-	$(POETRY) run coverage run -m pytest
+	$(POETRY) run pytest --cov=src
 
 
 .PHONY: report

MANIFEST.in

@@ -1,29 +1,45 @@
 # 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)
-[![DeepSource](https://deepsource.io/gh/qlient-org/python-qlient.svg/?label=resolved+issues&token=WQWScZui5Jy-cNg3fzvWxqhW)](https://deepsource.io/gh/qlient-org/python-qlient/?ref=repository-badge)
+[![DeepSource](https://deepsource.io/gh/qlient-org/python-qlient.svg/?label=active+issues&token=2ZJ0b1dinekjVtwgJHSy286C)](https://deepsource.io/gh/qlient-org/python-qlient/?ref=repository-badge)
+[![DeepSource](https://deepsource.io/gh/qlient-org/python-qlient.svg/?label=resolved+issues&token=2ZJ0b1dinekjVtwgJHSy286C)](https://deepsource.io/gh/qlient-org/python-qlient/?ref=repository-badge)
 [![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)
+[![codestyle](https://img.shields.io/badge/code%20style-black-black)](https://github.com/psf/black)
 
 A fast and modern graphql client designed with simplicity in mind.
 
+## Key Features
+
+* Compatible with Python 3.7 and above
+* Build on top of
+  [qlient-core](https://github.com/qlient-org/python-qlient-core),
+  [requests](https://github.com/psf/requests)
+  and [websocket-client](https://github.com/websocket-client/websocket-client/)
+* support for subscriptions
+
 ## Help
 
-See [documentation](https://qlient-org.github.io/python-qlient/) for more details
+See [documentation](https://qlient-org.github.io/python-qlient/) for more details.
+
+If you want more information about the internals,
+I kindly refer you to the [qlient-core documentation](https://qlient-org.github.io/python-qlient-core/).
+
+If you are looking for an asynchronous implementation,
+I kindly refer you to the [qlient-aiohttp](https://github.com/qlient-org/python-qlient-aiohttp) sister project.
 
 ## Installation
 
-```shell script
+```shell
 pip install qlient
 ```
 
 ## Quick Start
 
 ````python
-from qlient import Client, GraphQLResponse
+from qlient.http import HTTPClient, GraphQLResponse
 
-client = Client("https://swapi-graphql.netlify.app/.netlify/functions/index")
+client = HTTPClient("https://swapi-graphql.netlify.app/.netlify/functions/index")
 
 res: GraphQLResponse = client.query.film(
     # swapi graphql input fields
@@ -33,7 +49,7 @@ res: GraphQLResponse = client.query.film(
     _fields=["id", "title", "episodeID"]
 )
 
-print(res.query)  # query film($id: ID) { film(id: $id) { id title episodeID } }
-print(res.variables)  # {'id': 'ZmlsbXM6MQ=='}
+print(res.request.query)  # query film($id: ID) { film(id: $id) { id title episodeID } }
+print(res.request.variables)  # {'id': 'ZmlsbXM6MQ=='}
 print(res.data)  # {'film': {'id': 'ZmlsbXM6MQ==', 'title': 'A New Hope', 'episodeID': 4}}
 ````