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/.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 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..91f93b3 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 = "*" [tool.poetry.group.dev.dependencies] ipykernel = {version="^6.29.5", optional=true} @@ -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]