ci: Create a workflow that runs ruff (#52)

Author: CaedenPH

.github/workflows/ruff.yml

@@ -0,0 +1,16 @@
+# https://beta.ruff.rs
+name: ruff
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - run: pip install --user ruff
+    - run: ruff --format=github .

pyproject.toml

@@ -68,7 +68,16 @@ exclude = '''
 select = ["I", "D", "N", "UP"]
 line-length = 88
 
-ignore = ["D212", "D107", "D100", "D104", "D107", "N818", "D401", "D205"]
+ignore = [
+    "D100",  # Missing docstring in public module
+    "D104",  # Missing docstring in public package
+    "D107",  # Missing docstring in __init__
+    "D205",  # 1 blank line required between summary line and description
+    "D212",  # Multi-line docstring summary should start at the first line	
+    "N805",  # First argument of a method should be named self
+    "N818",  # Exception name ... should be named with an Error suffix
+    "UP035"  # Typing deprecations
+]
 
 exclude = [
     ".bzr",

surrealdb/__init__.py

@@ -13,7 +13,7 @@
 See the License for the specific language governing permissions and
 limitations under the License.
 """
-from .ws import Surreal
 from .http import SurrealHTTP
+from .ws import Surreal
 
 __all__ = ("Surreal", "SurrealHTTP")