chore: add pre-commit hook (#13)

.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+# 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: check-ast
+    -   id: check-json
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+
+- repo: https://github.com/pycqa/isort
+  rev: 5.12.0
+  hooks:
+    - id: isort

README.md

@@ -24,3 +24,8 @@ Steps:
     OPENAI_API_KEY=ab-0a0aaaaA0aaAAa0AaaaaA00aaaAA0aA0aaA0AaAAaaaaaa00
     ```
 3. Install dependencies: `pip install -r src/requirements.txt`
+
+Configure development environment:
+1. Run pip install -r src/requirements-dev.txt
+1. Install pre-commit hook: pre-commit install
+1. (Optional) run hook: pre-commit run --all-files

src/api/process.py

@@ -1,10 +1,10 @@
 import logging
 from enum import Enum
+from io import StringIO
 
+import openai
 import pandas as pd
 from dotenv import dotenv_values
-from io import StringIO
-import openai
 
 logger = logging.getLogger(__name__)
 # Set other loggers to error to not clutter this app's logs
@@ -67,4 +67,3 @@ def get_da_vinci_response(dataset_of: str) -> str:
 
 def get_models() -> list[str]:
     return [m.value for m in Models]
-

src/frontend/st_app.py

@@ -1,7 +1,8 @@
-import streamlit as st
 import time
 
-from src.api.process import get_response, get_models
+import streamlit as st
+
+from src.api.process import get_models, get_response
 from src.frontend.util import df_to_csv, df_to_json
 
 app_title = "Dataset Generator"

src/requirements-dev.txt

@@ -0,0 +1 @@
+pre-commit==3.3.3