Skip to content

Add optional uv installation instructions to README & make uv command visible on Landing Page next to pip install window - #5

Merged
jpolec merged 2 commits into
QuantJourneyOrg:mainfrom
datasound-projects:docs/add-uv-install
Jul 24, 2026
Merged

Add optional uv installation instructions to README & make uv command visible on Landing Page next to pip install window#5
jpolec merged 2 commits into
QuantJourneyOrg:mainfrom
datasound-projects:docs/add-uv-install

Conversation

@datasound-projects

Copy link
Copy Markdown
Contributor

What this changes

  • Adds an optional uv install command to the README
  • Adds the optional uv extras install example uv pip install "quantjourney-bt" or "quantjourney-bt[data,wf]"
  • Keeps the existing pip instructions unchanged

Why

  • uv gives users a fast modern Python install option
  • It works well with this package because quantjourney-bt already uses standard pyproject.toml packaging
  • It is helpful for users and contributors who already use uv

Benefits of uv

  • much faster installs
  • faster and more reliable dependency resolution
  • quick virtual environment creation
  • cleaner all-in-one Python workflow
  • efficient caching across projects
  • useful for faster local setup and CI runs

Extra request

  • Please also mirror this on the website landing page next to the current pip install window, so users can see the optional uv install path too

Signed-off-by: Patrick K. <patrick-kozak@protonmail.com>
@datasound-projects datasound-projects changed the title Add optional uv installation instructions to README Add optional uv installation instructions to README & Landing Page Jul 22, 2026
@datasound-projects datasound-projects changed the title Add optional uv installation instructions to README & Landing Page Add optional uv installation instructions to README & make uv command visible on Landing Page next to pip install window Jul 22, 2026
@jpolec
jpolec merged commit 102ff6a into QuantJourneyOrg:main Jul 24, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants