diff --git a/.github/workflows/integration.yaml b/.github/workflows/integration.yaml index 0b2f46d..f9b83f3 100644 --- a/.github/workflows/integration.yaml +++ b/.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 diff --git a/.github/workflows/publication.yaml b/.github/workflows/publication.yaml index 632d8de..5c3ccf7 100644 --- a/.github/workflows/publication.yaml +++ b/.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 diff --git a/README.md b/README.md index 0d1bcb7..9462bec 100644 --- a/README.md +++ b/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 --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. diff --git a/dspy_inspector/test_main.py b/dspy_inspector/test_main.py new file mode 100644 index 0000000..428bf31 --- /dev/null +++ b/dspy_inspector/test_main.py @@ -0,0 +1,5 @@ +_DSPY = "rocks" + + +def test_todo() -> None: + assert _DSPY == "rocks" diff --git a/pyproject.toml b/pyproject.toml index 17eadad..d9f14c4 100644 --- a/pyproject.toml +++ b/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"]