Merge pull request #5 from strawberry-graphql/setup-pre-commit

Author: jkimbo

.flake8

@@ -0,0 +1,7 @@
+[flake8]
+max-line-length = 88
+exclude=.venv,.git
+ignore = W503,E800
+extend-ignore =
+    # See https://github.com/PyCQA/pycodestyle/issues/373
+    E203,

.pre-commit-config.yaml

@@ -0,0 +1,37 @@
+repos:
+  - repo: https://github.com/PyCQA/flake8
+    rev: 3.9.2
+    hooks:
+      - id: flake8
+        additional_dependencies: ["flake8-eradicate==0.4.0"]
+
+  - repo: https://github.com/patrick91/pre-commit-alex
+    rev: aa5da9e54b92ab7284feddeaf52edf14b1690de3
+    hooks:
+      - id: alex
+        exclude: CHANGELOG.md
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v2.3.2
+    hooks:
+      - id: prettier
+        files: '.*\.mdx?$'
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+      - id: trailing-whitespace
+      - id: check-merge-conflict
+      - id: end-of-file-fixer
+      - id: check-toml
+
+  - repo: https://github.com/humitos/mirrors-autoflake.git
+    rev: v1.1
+    hooks:
+      - id: autoflake
+        args: ['--in-place', '--remove-all-unused-imports', '--remove-unused-variable']
+
+  - repo: https://github.com/psf/black
+    rev: 21.8b0
+    hooks:
+      - id: black

README.md

@@ -1,2 +1,3 @@
 # examples
+
 Example on how to use Strawberry

django-subscriptions-rxdb/README.md

@@ -1,9 +1,11 @@
 # django-subscriptions-rxdb
 
 ## tl;dr
+
 This example reproduces the server-side component of the RxDB GraphQL example, with a couple of extras, which can be found [here](https://github.com/pubkey/rxdb/tree/master/examples/graphql). Checkout RxDB and run the GraphQL example. When running Ok, change `export const GRAPHQL_PORT = 10102;` and `export const GRAPHQL_SUBSCRIPTION_PORT = 10103;` ([lines 1 and 3 of this file](https://github.com/pubkey/rxdb/blob/master/examples/graphql/shared.js)) to equal `8000`. Then in the directory of this README file, `make install && make run`. More information about RxDB and GraphQL synchronisation can be found [here](https://rxdb.info/replication-graphql.html).
 
 ## Requirements
+
 - [Clone of RxDB](https://github.com/pubkey/rxdb)
 - [Python 3.8+](https://www.python.org/downloads/) (might work with other versions, not tested)
 - [Poetry](https://python-poetry.org/)
@@ -13,11 +15,12 @@ This example reproduces the server-side component of the RxDB GraphQL example, w
 Tested on Ubuntu 20.04, should work everywhere these are available with no changes.
 
 ## Reason for this example
-While connectivity is getting better around the world every year, every user will always at least have moments when their connection is spotty, if not completely absent (at human prices) for certain periods (eg., on a plane). With an offline-first, local database and other offline-first tech (service workers, etc.), it is possible to develop web-technology-based applications  that will continue to offer much of their functionality offline, with realtime sync when they are online. This really is the best of both worlds, and can give much more fluid and friendly usage when connections are spotty.
+
+While connectivity is getting better around the world every year, every user will always have moments when their connection is spotty (eg. on a plane). With an offline-first, local database and other offline-first tech (service workers, etc.), it is possible to develop web-technology-based applications that will continue to offer much of their functionality offline, with realtime sync when they are online. This really is the best of both worlds, and can give much more fluid and friendly usage when connections are spotty.
 
 So you already have a Django-based app, and want to add some rich, client-side, offline-first functionality without starting from scratch? This is an example of some of the server-side code for one way of starting out.
 
-The RxDB component of this is not included here to keep things as light as possible. Offline-first has complexities that need to be mastered, so this is not intended to be a template or even a particularly good way of doing things, just a rough example to get you started with `rxdb`, `strawberry`, `django` and `broadcaster`.
+The RxDB component of this is not included here to keep things as light as possible. Offline-first has complexities that need to be mastered, so this is not intended to be a template or even a particularly good way of doing things. It's one rough example to get you started with `rxdb`, `strawberry`, `django` and `broadcaster`.
 
 ### The full example stack
 
@@ -29,6 +32,6 @@ If you use PostgreSQL then you will have to set up a database like you would for
 make install-postgres
 ```
 
-Now simply run `make run` as usual to run it.
+Now run `make run` as usual to run it.
 
-This extended setup shows how you can have multiple instances of your Django (in a Kubernetes cluster, for example), and realtime notifications will work for any client connected to any of the servers. This example uses [broadcaster](https://github.com/encode/broadcaster) for subscription notifications which, in addition to `postgres`, supports `memory` (for a single node), `redis` and `kafka`. If your `django` is not using `postgres` and/or you are using one of the other options for caching or messaging, you might want to use one of those. It should Just Work if you follow the `broadcaster` docs for the connection string.
+This extended setup shows how you can have multiple instances of your Django (in a Kubernetes cluster, for example), and realtime notifications will work for any client connected to any of the servers. This example uses [broadcaster](https://github.com/encode/broadcaster) for subscription notifications which, in addition to `postgres`, supports `memory` (for a single node), `redis` and `kafka`. If your `django` is not using `postgres` and/or you are using one of the other options for caching or messaging, you might want to use one of those. It should work if you follow the `broadcaster` docs for the connection string.

django-subscriptions-rxdb/manage.py

@@ -6,7 +6,7 @@
 
 def main():
     """Run administrative tasks."""
-    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'demo.settings')
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "demo.settings")
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc:
@@ -18,5 +18,5 @@ def main():
     execute_from_command_line(sys.argv)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

django-subscriptions-rxdb/src/api/context.py

@@ -19,7 +19,10 @@ async def get_broadcast():
                 if dbinfo.get("PORT")
                 else dbinfo.get("HOST")
             )
-            dsnstr = f"postgresql://{dbinfo.get('USER')}:{dbinfo.get('PASSWORD')}@{host}/{dbinfo.get('NAME')}"
+            dsnstr = (
+                f"postgresql://{dbinfo.get('USER')}:"
+                f"{dbinfo.get('PASSWORD')}@{host}/{dbinfo.get('NAME')}"
+            )
             broadcast = Broadcast(dsnstr)
         else:
             broadcast = Broadcast("memory://")

django-subscriptions-rxdb/src/api/models.py

@@ -1,9 +1,6 @@
 # -*- coding: utf-8 -*-
 
-from asgiref.sync import sync_to_async
-from django.contrib.auth.models import User
 from django.db import models
-from django.db.models import Q
 
 
 class Hero(models.Model):

django-subscriptions-rxdb/src/api/schema.py

@@ -1,15 +1,13 @@
 # -*- coding: utf-8 -*-
 
-import asyncio
 import time
-import traceback
 from typing import List, Optional
 
 import strawberry
 from asgiref.sync import sync_to_async
 from django.core.serializers import deserialize, serialize
 from django.db.models import Q
-from strawberry_django import ModelResolver, types
+from strawberry_django import ModelResolver
 
 from api import models
 
@@ -36,9 +34,9 @@ class Hero(HeroResolver.output_type):
 #   updatedAt: Float
 #   deleted: Boolean!
 # }
-# The client code expects the input type to be called "HeroInput", not "CreateHero", which is the default
-# We therefore need to create a new type via the strawberry.input decorator
-# class HeroInput(HeroResolver.create_input_type):
+# The client code expects the input type to be called "HeroInput",
+# not "CreateHero", which is the default We therefore need to create a new type
+# via the strawberry.input decorator
 @strawberry.input
 class HeroInput(HeroResolver.create_input_type):
     pass
@@ -67,11 +65,11 @@ def filterHeroes(
 
 @strawberry.type
 class Query:
-    ## to include the auto-generated methods from strawberry-graphql-django:
-    ## - hero(id: ID!): Hero!
-    ## - heros(filters: [String!] = null): [Hero!]!
-    ## declare the class as
-    ## class Query(HeroResolver.query()):
+    # to include the auto-generated methods from strawberry-graphql-django:
+    # - hero(id: ID!): Hero!
+    # - heros(filters: [String!] = null): [Hero!]!
+    # declare the class as
+    # class Query(HeroResolver.query()):
 
     # type Query {
     #   feedHero(id: String, updatedAt: Float, limit: Int!): [Hero!]!

django-subscriptions-rxdb/src/demo/settings.py

@@ -66,7 +66,9 @@
 
 AUTH_PASSWORD_VALIDATORS = [
     {
-        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+        "NAME": (
+            "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"
+        ),
     },
     {
         "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",

django-subscriptions/demo/settings.py

@@ -20,7 +20,7 @@
 # See https://docs.djangoproject.com/en/3.1/howto/deployment/checklist/
 
 # SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = 'p-h@br&tcqetcsaa%))9%5-80qjv&*-2_@6eddvp!3m)z#kyq%'
+SECRET_KEY = "p-h@br&tcqetcsaa%))9%5-80qjv&*-2_@6eddvp!3m)z#kyq%"
 
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
@@ -31,52 +31,52 @@
 # Application definition
 
 INSTALLED_APPS = [
-    'django.contrib.admin',
-    'django.contrib.auth',
-    'django.contrib.contenttypes',
-    'django.contrib.sessions',
-    'django.contrib.messages',
-    'django.contrib.staticfiles',
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
 ]
 
 MIDDLEWARE = [
-    'django.middleware.security.SecurityMiddleware',
-    'django.contrib.sessions.middleware.SessionMiddleware',
-    'django.middleware.common.CommonMiddleware',
-    'django.middleware.csrf.CsrfViewMiddleware',
-    'django.contrib.auth.middleware.AuthenticationMiddleware',
-    'django.contrib.messages.middleware.MessageMiddleware',
-    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
 ]
 
-ROOT_URLCONF = 'demo.urls'
+ROOT_URLCONF = "demo.urls"
 
 TEMPLATES = [
     {
-        'BACKEND': 'django.template.backends.django.DjangoTemplates',
-        'DIRS': [],
-        'APP_DIRS': True,
-        'OPTIONS': {
-            'context_processors': [
-                'django.template.context_processors.debug',
-                'django.template.context_processors.request',
-                'django.contrib.auth.context_processors.auth',
-                'django.contrib.messages.context_processors.messages',
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
             ],
         },
     },
 ]
 
-WSGI_APPLICATION = 'demo.wsgi.application'
+WSGI_APPLICATION = "demo.wsgi.application"
 
 
 # Database
 # https://docs.djangoproject.com/en/3.1/ref/settings/#databases
 
 DATABASES = {
-    'default': {
-        'ENGINE': 'django.db.backends.sqlite3',
-        'NAME': BASE_DIR / 'db.sqlite3',
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
     }
 }
 
@@ -86,26 +86,28 @@
 
 AUTH_PASSWORD_VALIDATORS = [
     {
-        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+        "NAME": (
+            "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"
+        ),
     },
     {
-        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
     },
     {
-        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
     },
     {
-        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
     },
 ]
 
 
 # Internationalization
 # https://docs.djangoproject.com/en/3.1/topics/i18n/
 
-LANGUAGE_CODE = 'en-us'
+LANGUAGE_CODE = "en-us"
 
-TIME_ZONE = 'UTC'
+TIME_ZONE = "UTC"
 
 USE_I18N = True
 
@@ -117,4 +119,4 @@
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/3.1/howto/static-files/
 
-STATIC_URL = '/static/'
+STATIC_URL = "/static/"