diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 52f486b..aa41ebb 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -3,22 +3,13 @@ name: CI on: [pull_request, workflow_dispatch] jobs: -# pre-commit: -# name: Run pre-commit -# runs-on: ubuntu-latest -# steps: -# - uses: actions/checkout@v3 -# - uses: actions/setup-python@v3 -# - uses: pre-commit/action@v3.0.0 - test: name: Tests for Python ${{ matrix.python-version }} runs-on: ubuntu-latest strategy: matrix: - python-version: ['3.10'] + python-version: [ "3.10" ] fail-fast: false -# needs: pre-commit steps: - uses: actions/checkout@v3 @@ -31,6 +22,7 @@ jobs: - name: Install dependencies run: | pip install -e . + pip install -r requirements-dev.txt - name: Run tests run: | diff --git a/INSTALL.md b/INSTALL.md index 842fca8..d5c7f7d 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -19,17 +19,33 @@ python3 -m pip install -U pip wheel setuptools ``` -## install the Jupyter kernel +## install ```bash +python3 -m pip install -e . python3 -m bwyd.install ``` -## uninstall the Jupyter kernel +## uninstall ```bash ./venv/bin/jupyter kernelspec uninstall bwyd +python3 -m pip uninstall bwyd +``` + + +## set up the developer environment + +```bash +python3 -m pip install -r requirements-dev.txt +``` + + +## run unit tests + +```bash +python3 -m pytest ``` @@ -44,3 +60,5 @@ python3 -m bwyd.install - `demo.py`: Python demo app - `examples/gnocchi.bwyd`: example Gnocchi recipe in Bwyd, as a script - `examples/gnocchi.ipynb`: example Gnocchi recipe in Bwyd, as a Jupyter notebook + + - `tests/*.py`: unit tests diff --git a/MANIFEST.in b/MANIFEST.in index 1fc678c..1dcc2b6 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -5,7 +5,9 @@ include bwyd/kernel.json include bwyd/*.py include pyproject.toml include requirements.txt +include requirements-dev.txt include setup.py +include tests/* prune .ipynb_checkpoints prune docs prune venv diff --git a/pyproject.toml b/pyproject.toml index 908e774..d13d0b5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -31,8 +31,9 @@ readme = "README.md" license = { file = "LICENSE" } requires-python = ">=3.10" +description = "The seed crazy idea behind the scenes here is to consider how human cooks behave somewhat like robots, following recipes as instructions." + dynamic = [ - "description", "version" ] diff --git a/requirements-dev.txt b/requirements-dev.txt new file mode 100644 index 0000000..27bb3ad --- /dev/null +++ b/requirements-dev.txt @@ -0,0 +1,2 @@ +deepdiff >= 6.7 +pytest >= 8.0