Merge pull request #53 from codeguru42/51-black

51 black

Author: codeguru42

.github/workflows/build.yaml

@@ -10,6 +10,9 @@ jobs:
       - name: Checkout repo
         uses: actions/checkout@v3
 
+      - name: black
+        uses: psf/black@stable
+
       - name: Configure AWS credentials
         uses: aws-actions/configure-aws-credentials@v1-node16
         with:

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-added-large-files
+-   repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+    -   id: black

README.md

@@ -1,6 +1,7 @@
 # Go Capture API
 
 ![Build](https://github.com/codeguru42/go-capture-api/actions/workflows/build.yaml/badge.svg)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 Go Capture API is a REST API that will generate an SGF file from an image of a Go position.
 
@@ -9,6 +10,12 @@ Go Capture API is a REST API that will generate an SGF file from an image of a G
 * Python 3.11+
 * Docker and Docker Compose
 
+## Commit hooks
+
+```shell
+pre-commit install
+```
+
 ## Run
 
 ```shell

go_capture/__init__.py

@@ -1,3 +1,3 @@
 from .tasks import app as celery_app
 
-__all__ = ('celery_app',)
+__all__ = ("celery_app",)

go_capture/asgi.py

@@ -11,6 +11,6 @@
 
 from django.core.asgi import get_asgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'go_capture.settings')
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "go_capture.settings")
 
 application = get_asgi_application()

go_capture/settings.py

@@ -23,62 +23,62 @@
 # Quick-start development settings - unsuitable for production
 # See https://docs.djangoproject.com/en/4.1/howto/deployment/checklist/
 
-SECRET_KEY = env.str('DJANGO_SECRET_KEY')
+SECRET_KEY = env.str("DJANGO_SECRET_KEY")
 
 # SECURITY WARNING: don't run with debug turned on in production!
-DEBUG = env.bool('DJANGO_DEBUG', False)
+DEBUG = env.bool("DJANGO_DEBUG", False)
 
-ALLOWED_HOSTS = env.list('DJANGO_ALLOWED_HOSTS')
+ALLOWED_HOSTS = env.list("DJANGO_ALLOWED_HOSTS")
 
 
 # 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.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.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
 ]
 
-ROOT_URLCONF = 'go_capture.urls'
+ROOT_URLCONF = "go_capture.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 = 'go_capture.wsgi.application'
+WSGI_APPLICATION = "go_capture.wsgi.application"
 
 
 # Database
 # https://docs.djangoproject.com/en/4.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",
     }
 }
 
@@ -88,26 +88,26 @@
 
 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/4.1/topics/i18n/
 
-LANGUAGE_CODE = 'en-us'
+LANGUAGE_CODE = "en-us"
 
-TIME_ZONE = 'UTC'
+TIME_ZONE = "UTC"
 
 USE_I18N = True
 
@@ -117,21 +117,21 @@
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/4.1/howto/static-files/
 
-STATIC_URL = 'static/'
+STATIC_URL = "static/"
 
 # Default primary key field type
 # https://docs.djangoproject.com/en/4.1/ref/settings/#default-auto-field
 
-DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
 
-MEDIA_URL = 'media/'
-MEDIA_ROOT = BASE_DIR / 'media'
+MEDIA_URL = "media/"
+MEDIA_ROOT = BASE_DIR / "media"
 MEDIA_ROOT.mkdir(exist_ok=True)
 
-IMAGES_DIR = MEDIA_ROOT / 'images'
+IMAGES_DIR = MEDIA_ROOT / "images"
 IMAGES_DIR.mkdir(exist_ok=True)
 
-SGF_DIR = MEDIA_ROOT / 'sgf'
+SGF_DIR = MEDIA_ROOT / "sgf"
 SGF_DIR.mkdir(exist_ok=True)
 
-FIREBASE_CREDENTIALS_FILE = BASE_DIR / env.str('FIREBASE_CREDENTIALS_FILE')
+FIREBASE_CREDENTIALS_FILE = BASE_DIR / env.str("FIREBASE_CREDENTIALS_FILE")

go_capture/sgf/find_stones.py

@@ -56,7 +56,7 @@ def draw_patches(image, coords, color):
 
 def get_clusters(board):
     pixels = np.float32(board.reshape(-1, 3))
-    criteria = (cv2.TERM_CRITERIA_EPS + cv2.TERM_CRITERIA_MAX_ITER, 200, .1)
+    criteria = (cv2.TERM_CRITERIA_EPS + cv2.TERM_CRITERIA_MAX_ITER, 200, 0.1)
     flags = cv2.KMEANS_RANDOM_CENTERS
     _, labels, palette = cv2.kmeans(pixels, 6, None, criteria, 10, flags)
     width, height, _ = board.shape

go_capture/sgf/make_sgf.py

@@ -4,10 +4,10 @@ def write_stones(file, stones):
 
 
 def make_sgf(file, black, white):
-    file.write('(;FF[4]\n')
-    file.write('GM[1]\n')
-    file.write(';AB')
+    file.write("(;FF[4]\n")
+    file.write("GM[1]\n")
+    file.write(";AB")
     write_stones(file, black)
-    file.write('\n;AW')
+    file.write("\n;AW")
     write_stones(file, white)
-    file.write('\n)\n')
+    file.write("\n)\n")

go_capture/sgf/perspective.py

@@ -24,7 +24,10 @@ def perspective_transform(image, corners):
 
     # Construct new points to obtain top-down view of image in
     # top_r, top_l, bottom_l, bottom_r order
-    dimensions = np.array([[0, 0], [width - 1, 0], [width - 1, height - 1], [0, height - 1]], dtype="float32")
+    dimensions = np.array(
+        [[0, 0], [width - 1, 0], [width - 1, height - 1], [0, height - 1]],
+        dtype="float32",
+    )
 
     # Convert to Numpy format
     ordered_corners = np.array((top_l, top_r, bottom_r, bottom_l), dtype="float32")
@@ -40,7 +43,9 @@ def get_corners(image):
     copy = image.copy()
     gray = cv2.cvtColor(copy, cv2.COLOR_BGR2GRAY)
     blur = cv2.medianBlur(gray, 3)
-    thresh = cv2.adaptiveThreshold(blur, 255, cv2.ADAPTIVE_THRESH_GAUSSIAN_C, cv2.THRESH_BINARY_INV, 11, 3)
+    thresh = cv2.adaptiveThreshold(
+        blur, 255, cv2.ADAPTIVE_THRESH_GAUSSIAN_C, cv2.THRESH_BINARY_INV, 11, 3
+    )
     contours, _ = cv2.findContours(thresh, cv2.RETR_EXTERNAL, cv2.CHAIN_APPROX_SIMPLE)
     sorted_contours = sorted(contours, key=cv2.contourArea, reverse=True)
     return sorted_contours[0]

go_capture/tasks.py

@@ -9,15 +9,15 @@
 from go_capture.sgf.process_image import process_image
 
 # Set the default Django settings module for the 'celery' program.
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'go_capture.settings')
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "go_capture.settings")
 
-app = Celery('go_capture')
+app = Celery("go_capture")
 
 # Using a string here means the worker doesn't have to serialize
 # the configuration object to child processes.
 # - namespace='CELERY' means all celery-related configuration keys
 #   should have a `CELERY_` prefix.
-app.config_from_object('django.conf:settings', namespace='CELERY')
+app.config_from_object("django.conf:settings", namespace="CELERY")
 
 # Load task modules from all registered Django apps.
 app.autodiscover_tasks()
@@ -28,14 +28,14 @@
 
 @app.task(bind=True)
 def debug_task(self):
-    print(f'Request: {self.request!r}')
+    print(f"Request: {self.request!r}")
 
 
 @app.task
 def process_image_task(image_filename, fcm_token):
-    print(f'token: {fcm_token}')
-    print(f'Processing {image_filename}')
-    with open(image_filename, 'rb') as image_file:
+    print(f"token: {fcm_token}")
+    print(f"Processing {image_filename}")
+    with open(image_filename, "rb") as image_file:
         sgf_buffer = io.StringIO()
         process_image(image_file, sgf_buffer)
 
@@ -44,7 +44,7 @@ def process_image_task(image_filename, fcm_token):
     print(sgf_data)
     message = messaging.Message(
         data={
-            'sgf': sgf_data,
+            "sgf": sgf_data,
         },
         token=fcm_token,
     )
@@ -53,4 +53,4 @@ def process_image_task(image_filename, fcm_token):
     # registration token.
     response = messaging.send(message)
     # Response is a message ID string.
-    print('Successfully sent message:', response)
+    print("Successfully sent message:", response)