From c6b96de590cd3ffc704881d0eea7020743d10780 Mon Sep 17 00:00:00 2001 From: Paco Nathan Date: Mon, 4 Mar 2024 10:17:04 -0800 Subject: [PATCH 1/4] test CI pipeline --- INSTALL.md | 15 +++++++++++++-- MANIFEST.in | 1 + 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 842fca8..fd8d739 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -19,17 +19,26 @@ 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 +``` + + +## run unit tests + +```bash +python3 -m pytest ``` @@ -44,3 +53,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..b236b0d 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -6,6 +6,7 @@ include bwyd/*.py include pyproject.toml include requirements.txt include setup.py +include tests/* prune .ipynb_checkpoints prune docs prune venv From b1372f21f12bdd18fe81e68ff36b3f7687616766 Mon Sep 17 00:00:00 2001 From: Paco Nathan Date: Mon, 4 Mar 2024 10:21:47 -0800 Subject: [PATCH 2/4] fix project yml --- pyproject.toml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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" ] From fcc53ade891f64cbe08302918c3507bde8fcd811 Mon Sep 17 00:00:00 2001 From: Paco Nathan Date: Mon, 4 Mar 2024 10:24:59 -0800 Subject: [PATCH 3/4] update requirements --- INSTALL.md | 7 +++++++ MANIFEST.in | 1 + requirements-dev.txt | 2 ++ 3 files changed, 10 insertions(+) create mode 100644 requirements-dev.txt diff --git a/INSTALL.md b/INSTALL.md index fd8d739..d5c7f7d 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -35,6 +35,13 @@ python3 -m pip uninstall bwyd ``` +## set up the developer environment + +```bash +python3 -m pip install -r requirements-dev.txt +``` + + ## run unit tests ```bash diff --git a/MANIFEST.in b/MANIFEST.in index b236b0d..1dcc2b6 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -5,6 +5,7 @@ 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 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 From c3dd02d172a5a349377248258f83d73c8b3656ce Mon Sep 17 00:00:00 2001 From: Paco Nathan Date: Mon, 4 Mar 2024 10:27:17 -0800 Subject: [PATCH 4/4] update CI yml --- .github/workflows/ci.yml | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) 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: |