Test out Codeflash (#93)

* Test out Codeflash

Signed-off-by: GitHub <[email protected]>

* Ignore new lint

Signed-off-by: GitHub <[email protected]>

---------

Signed-off-by: GitHub <[email protected]>

.github/workflows/codeflash-optimize.yaml

@@ -0,0 +1,32 @@
+name: Codeflash
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  optimize:
+    name: Optimize new code in this PR
+    if: ${{ github.actor != 'codeflash-ai[bot]' }}
+    runs-on: ubuntu-latest
+    env:
+      CODEFLASH_API_KEY: ${{ secrets.CODEFLASH_API_KEY }}
+      CODEFLASH_PR_NUMBER: ${{ github.event.number }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - name: Install Project Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .
+          pip install codeflash
+      - name: Run Codeflash to optimize code
+        id: optimize_code
+        run: |
+          codeflash

pyproject.toml

@@ -49,6 +49,7 @@ select = ["ALL"]
 ignore = [
     "CPY001", # (Missing copyright notice at top of file)
     "S311", # (Standard pseudo-random generators are not suitable for cryptographic purposes) - Really?
+    "DOC201", # (`return` is not documented in docstring) - TODO
 ]
 
 [tool.ruff.lint.extend-per-file-ignores]
@@ -66,3 +67,11 @@ known-first-party = ["imsosorry.uwuification"]
 
 [tool.ruff.lint.pydocstyle]
 convention = "numpy"
+
+[tool.codeflash]
+# All paths are relative to this pyproject.toml's directory.
+module-root = "src"
+tests-root = "tests"
+test-framework = "pytest"
+ignore-paths = []
+formatter-cmds = ["ruff check --exit-zero --fix $file", "ruff format $file"]