Merge pull request #2 from andrewyng/change-formatter-to-black

Updating the formatter to use Black instead of Ruff.

After a conversation with John and Ryan we felt it was better to use the more
established tool for formatting.

The PR:
- updates dependencies in the pyproject.toml
- updates the pre-commit config to use black
- adds the github action for linting checks
- adds the black badge on the README

.github/workflows/black.yml

@@ -0,0 +1,10 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: psf/black@stable

.pre-commit-config.yaml

@@ -1,10 +1,11 @@
 repos:
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    # Ruff version.
-    rev: v0.5.0
+  # Using this mirror lets us use mypyc-compiled black, which is about 2x faster
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 24.4.2
     hooks:
-      # Run the linter.
-      - id: ruff
-        args: [ --fix ]
-      # Run the formatter.
-      - id: ruff-format
+      - id: black
+        # It is recommended to specify the latest version of Python
+        # supported by your project here, or alternatively use
+        # pre-commit's default_language_version, see
+        # https://pre-commit.com/#top_level-default_language_version
+        language_version: python3.11

README.md

@@ -1,2 +1,4 @@
 # aimodels
 Simple, unified interface to multiple Generative AI providers 
+
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

pyproject.toml

@@ -7,13 +7,13 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.10"
-python-dotenv = "^1.0.1"
 
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.2.2"
-ruff = "^0.5.0"
 pre-commit = "^3.7.1"
+black = "^24.4.2"
+python-dotenv = "^1.0.1"
 
 [build-system]
 requires = ["poetry-core"]