Merge pull request #2 from Neoxelox/fix/ci-cd

Fix CI & CD

.github/workflows/integration.yaml

@@ -23,11 +23,11 @@ jobs:
       - name: Setup Scripts 🧩
         run: |
           poetry install
-          inv env.switch ci
-          inv tool.install ci-int --yes
+          poetry run inv env.switch ci
+          poetry run inv tool.install ci-int --yes
 
       - name: Lint 🪶
-        run: inv lint
+        run: poetry run inv lint
 
       - name: Test 🧪
-        run: inv test
+        run: poetry run inv test

.github/workflows/publication.yaml

@@ -30,11 +30,11 @@ jobs:
       - name: Setup Scripts 🧩
         run: |
           poetry install
-          inv env.switch ci
-          inv tool.install ci-dep --yes
+          poetry run inv env.switch ci
+          poetry run inv tool.install ci-dep --yes
 
       - name: Build 🏗️
-        run: inv build
+        run: poetry run inv build
 
       - name: Publish 🚀
-        run: inv publish
+        run: poetry run inv publish

README.md

@@ -1,5 +1,36 @@
-# dspy-inspector
+# dspy-inspector 🔍
 
-DSPy program/pipeline inspector widget for Jupyter/VSCode Notebook.
+**`DSPy program/pipeline inspector widget for Jupyter/VSCode Notebook.`** 🔭
+
+## Install
+
+👉 `pip install dspy-inspector`
+
+## What
+
+TODO: Explain
+
+## Features
+
+TODO: Explain
+
+## Usage
 
 TODO: Explain
+
+## Developing
+
+To setup the virtual environment, follow these steps:
+
+1. Install dependencies: `poetry install`
+2. Install tools `poetry run inv tool.install --include "dev*"`
+
+Run `poetry run inv help` for further commands and `poetry run inv <command> --help` for their usage.
+
+## Contribute
+
+Feel free to contribute to this project : ) .
+
+## License
+
+This project is licensed under the [GPL-3.0 License](https://opensource.org/licenses/GPL-3) - read the [LICENSE](LICENSE) file for details.

dspy_inspector/test_main.py

@@ -0,0 +1,5 @@
+_DSPY = "rocks"
+
+
+def test_todo() -> None:
+    assert _DSPY == "rocks"

pyproject.toml

@@ -53,7 +53,7 @@ jobs = "auto"
 exclude = ["**/__pycache__/*", "**/__init__.py"]
 
 [tool.flakehell.plugins]
-"flake8-black" = ["+*"]
+"flake8-black" = ["+*", "-BLK999"]
 "flake8-isort" = ["+*"]
 mccabe = ["+*"]
 pycodestyle = ["+*", "-W0621", "-E203", "-E1101", "-W503"]