Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add uv among command example to work with virtual env and quarto #12104

Open
cderv opened this issue Feb 17, 2025 · 4 comments
Open

Add uv among command example to work with virtual env and quarto #12104

cderv opened this issue Feb 17, 2025 · 4 comments
Assignees
Labels
documentation Doc improvements & quarto-web python-setup Issues with Python's environment and setup
Milestone

Comments

@cderv
Copy link
Collaborator

cderv commented Feb 17, 2025

Thanks, the suggestion to wrap quarto render inside uv run works here and seems like the cleanest option.

You can also leverage uv run directly, as the command will be ran in the virtual env

Maybe content about uv could be added to the Quarto docs on virtual environments?

https://quarto.org/docs/projects/virtual-environments.html

Originally posted by @westat-schneider in #12053

We are mentionning venv and how to create it. uv seems widely use and it could be interesting to document it too.

@cderv cderv added documentation Doc improvements & quarto-web python-setup Issues with Python's environment and setup labels Feb 17, 2025
@cderv cderv added this to the Future milestone Feb 17, 2025
@cderv cderv self-assigned this Feb 17, 2025
@mcanouil
Copy link
Collaborator

FWIW, I agree with the addition of uv example, but I am a bit concerned that it will need updates/maintenance if we add it now or in few months, as the API evolves quite rapidly and with breaking changes.

@cderv
Copy link
Collaborator Author

cderv commented Feb 17, 2025

The only thing we really need from uv in my opinion is

  • Explain that it can be used with Quarto
  • Link to their doc one how to create virtualenv with it

then mention

  • Activating the venv (which is not a uv command), then quarto render - this is what we document already
  • Run uv run quarto render

I was not planning to go deeper in uv api and so was not really concerned about API change on their part.

What do you think could be worth waiting for more stability ?

@mcanouil
Copy link
Collaborator

If uv run is stable in the sense that the command itself is not going to change or its behaviour, it's fine.

I did not check uv run but I've seen few days ago in the changelog:

uv publish is no longer in preview

I'm just saying to check the status.

@cderv
Copy link
Collaborator Author

cderv commented Feb 17, 2025

ok - good to keep in mind. I was wondering if you spotted anything specific. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Doc improvements & quarto-web python-setup Issues with Python's environment and setup
Projects
None yet
Development

No branches or pull requests

2 participants