From 258fa70166017b927aa32ca77d168a5e683421ff Mon Sep 17 00:00:00 2001 From: Henry Webel Date: Thu, 30 Jan 2025 14:41:18 +0100 Subject: [PATCH 1/4] =?UTF-8?q?=E2=9E=95=20Add=20quarto=20as=20default=20d?= =?UTF-8?q?ependency?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/cdci.yml | 2 +- README.md | 16 ++++++---------- pyproject.toml | 2 +- 3 files changed, 8 insertions(+), 12 deletions(-) diff --git a/.github/workflows/cdci.yml b/.github/workflows/cdci.yml index 9e3b98b..4731261 100644 --- a/.github/workflows/cdci.yml +++ b/.github/workflows/cdci.yml @@ -53,7 +53,7 @@ jobs: - name: Install dependencies run: | pip install --upgrade pip - pip install -e ".[quarto]" + pip install -e "." - name: Execute streamlit report (to check) run: | cd docs diff --git a/README.md b/README.md index 3bd03b1..808ce35 100644 --- a/README.md +++ b/README.md @@ -47,27 +47,23 @@ pip install -e path/to/vuegen # specify location pip install -e . # in case your pwd is in the vuegen directory ``` -### Quarto installation +This will both install `quarto` and `streamlit` as our backends for report generation. -Install quarto with vueguen if you don't have it globally installed. +### Verify quarto installation + +Test your quarto installation by running the following command: ```bash -pip install -e ".[quarto]" # specify location +quarto check ``` -if you use conda a conda environement you can install quatro from the conda-forge channel +If you use conda a conda environement you can install quatro from the conda-forge channel in case it did not work. ```bash conda install -c conda-forge quarto ``` -Test your quarto installation by running the following command: - -```bash -quarto check -``` - ## Execution Run VueGen using a directory with the following command: diff --git a/pyproject.toml b/pyproject.toml index b919280..535bb46 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -34,7 +34,7 @@ ipywidgets = {version="*", optional=true} sphinx-new-tab-link = {version = "!=0.2.2", optional=true} jupytext = {version="*", optional=true} # quarto -quarto-cli = {version="*", optional=true} +quarto-cli = {version="*"} [tool.poetry.group.dev.dependencies] ipykernel = {version="^6.29.5", optional=true} From 951b093e76178f2fc3a8a79fcdfd09db38b4167a Mon Sep 17 00:00:00 2001 From: Henry Webel Date: Thu, 30 Jan 2025 14:51:47 +0100 Subject: [PATCH 2/4] :bug: change not picked up on ubuntu? --- pyproject.toml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 535bb46..cca024a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -34,7 +34,7 @@ ipywidgets = {version="*", optional=true} sphinx-new-tab-link = {version = "!=0.2.2", optional=true} jupytext = {version="*", optional=true} # quarto -quarto-cli = {version="*"} +quarto-cli = "*" [tool.poetry.group.dev.dependencies] ipykernel = {version="^6.29.5", optional=true} @@ -45,8 +45,8 @@ build-backend = "poetry.core.masonry.api" # https://stackoverflow.com/a/60990574/9684872 [tool.poetry.extras] -streamlit = ["streamlit"] -quarto = ["quarto-cli", "ipykernel"] +# streamlit = ["streamlit"] +# quarto = ["quarto-cli", "ipykernel"] docs = ["sphinx", "sphinx-book-theme", "myst-nb", "ipywidgets", "sphinx-new-tab-link", "jupytext"] [tool.poetry.scripts] From 32c7d920aa8009a42abc4ae432132a7b6508191f Mon Sep 17 00:00:00 2001 From: Henry Webel Date: Thu, 30 Jan 2025 14:53:01 +0100 Subject: [PATCH 3/4] :bug: remove missing extra for building docs --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 851cd08..7ff7221 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -26,7 +26,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install -e .[docs,quarto] + pip install -e .[docs] - name: Build references run: | cd docs From cef66543ed791c26684902ff9c21a15250e055db Mon Sep 17 00:00:00 2001 From: Henry Webel Date: Thu, 30 Jan 2025 14:58:42 +0100 Subject: [PATCH 4/4] :art: clean-up --- pyproject.toml | 2 -- 1 file changed, 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index cca024a..91f93b3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -45,8 +45,6 @@ build-backend = "poetry.core.masonry.api" # https://stackoverflow.com/a/60990574/9684872 [tool.poetry.extras] -# streamlit = ["streamlit"] -# quarto = ["quarto-cli", "ipykernel"] docs = ["sphinx", "sphinx-book-theme", "myst-nb", "ipywidgets", "sphinx-new-tab-link", "jupytext"] [tool.poetry.scripts]