Merge pull request #19 from nova-model/17-update-readme

Switch to Pixi

Author: evilkermit

.github/workflows/test.yml

@@ -23,10 +23,10 @@ jobs:
           file: Dockerfile
           load: true
       - name: Run ruff check
-        run: docker run --rm ${{ steps.build.outputs.imageid }} poetry run ruff check
+        run: docker run --rm ${{ steps.build.outputs.imageid }} ruff check
       - name: Run format check
-        run: docker run --rm ${{ steps.build.outputs.imageid }} poetry run ruff format --check
+        run: docker run --rm ${{ steps.build.outputs.imageid }} ruff format --check
       - name: Run mypy
-        run: docker run --rm ${{ steps.build.outputs.imageid }} poetry run mypy .
+        run: docker run --rm ${{ steps.build.outputs.imageid }} mypy .
       - name: Run tests
-        run: docker run --rm -e GALAXY_URL=${{ env.GALAXY_URL }} -e GALAXY_API_KEY=${{ env.GALAXY_API_KEY }} ${{ steps.build.outputs.imageid }} poetry run pytest test_examples.py
+        run: docker run --rm -e GALAXY_URL=${{ env.GALAXY_URL }} -e GALAXY_API_KEY=${{ env.GALAXY_API_KEY }} ${{ steps.build.outputs.imageid }} pytest test_examples.py

.pre-commit-config.yaml

@@ -20,7 +20,7 @@ repos:
   hooks:
     - id: mypy
       name: mypy
-      entry: poetry run mypy .
+      entry: pixi run mypy .
       language: system
       types: [python]
       verbose: true

Dockerfile

@@ -7,17 +7,17 @@ RUN apt update && apt install -y \
     libx11-dev \
     libxrender1
 
-ENV POETRY_HOME=/poetry
-ENV PATH=/poetry/bin:$PATH
-RUN curl -sSL https://install.python-poetry.org | python3 -
+RUN curl -fsSL https://pixi.sh/install.sh | sh
+ENV PATH="/root/.pixi/bin:${PATH}"
 
 RUN mkdir -p /opt/run/examples
 COPY examples/ /opt/run/examples/
 COPY tests/ /opt/run/
 COPY pyproject.toml /opt/run/pyproject.toml
-COPY poetry.lock /opt/run/poetry.lock
 
 WORKDIR /opt/run
-RUN poetry install
+RUN pixi install
+SHELL [ "pixi", "run" ]
+ENTRYPOINT [ "pixi", "run" ]
 
 CMD []

README.md

@@ -27,20 +27,19 @@ We also provide examples that take advantage of ORNL resources:
 
 ## Running Examples
 
-If you want to run the examples, then you will need to install [Poetry](https://python-poetry.org/). Once done, run the following to run an example.
+If you want to run the examples, then you will need to install [Pixi](https://pixi.sh/latest/). Once done, run the following to run an example.
 
 ```bash
-poetry install
-poetry run python examples/{example_folder}/main.py
+pixi install
+pixi run python -m examples.{example_folder}
 ```
 
 ## Running Tests
 
 This repo includes an automated test to ensure that each example runs:
 
 ```bash
-poetry install
-poetry run pytest
+pixi run pytest
 ```
 
 You can set the environment variable `INCLUDE_ORNL_TESTS=1` if you want to test the examples that rely on specific ORNL resources. Note that you will need to run them from a location that has access to these resources.

examples/complex_pydantic_rules/__main__.py

@@ -0,0 +1,5 @@
+"""Entrypoint."""
+
+from .main import main
+
+main()

examples/conditional_disabling/__main__.py

@@ -0,0 +1,5 @@
+"""Entrypoint."""
+
+from .main import main
+
+main()

examples/conditional_rendering/__main__.py

@@ -0,0 +1,5 @@
+"""Entrypoint."""
+
+from .main import main
+
+main()

examples/data_selector/__main__.py

@@ -0,0 +1,5 @@
+"""Entrypoint."""
+
+from .main import main
+
+main()

examples/dialog/__main__.py

@@ -0,0 +1,5 @@
+"""Entrypoint."""
+
+from .main import main
+
+main()

examples/dynamic_pydantic_rules/__main__.py

@@ -0,0 +1,5 @@
+"""Entrypoint."""
+
+from .main import main
+
+main()