Skip to content

maint: switch local install description to use uv#1401

Merged
LennartPurucker merged 6 commits into
developfrom
uv_local_install
Jun 17, 2025
Merged

maint: switch local install description to use uv#1401
LennartPurucker merged 6 commits into
developfrom
uv_local_install

Conversation

@LennartPurucker
Copy link
Copy Markdown
Contributor

Make onboarding easier by switching to uv for the install.

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Jun 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.05%. Comparing base (d36593d) to head (39b485e).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1401   +/-   ##
========================================
  Coverage    84.05%   84.05%           
========================================
  Files           38       38           
  Lines         5230     5230           
========================================
  Hits          4396     4396           
  Misses         834      834           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread CONTRIBUTING.md Outdated
@LennartPurucker
Copy link
Copy Markdown
Contributor Author

Closes #1409

@LennartPurucker
Copy link
Copy Markdown
Contributor Author

@PGijsbers @SubhadityaMukherjee I recommend reading the new documentation files as markdown in the branch instead of via the file differences.

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Copy link
Copy Markdown
Collaborator

@PGijsbers PGijsbers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor mistakes

Co-authored-by: Pieter Gijsbers <p.gijsbers@tue.nl>
Comment thread CONTRIBUTING.md
However, it is also possible to use the [openml-python docker image](https://github.com/openml/openml-python/blob/main/docker/readme.md) for testing and building documentation. Moreover, feel free to use any alternative package managers, such as `pip`.


1. To ensure a smooth development experience, we recommend using the `uv` package manager. Thus, first install `uv`. If any Python version already exists on your system, follow the steps below, otherwise see [here](https://docs.astral.sh/uv/getting-started/installation/).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is it smooth for anyone who hasnt used uv? Maybe link to something that justifies using it would be a little nicer here I think. Guess probably something like this but more formal?

@LennartPurucker LennartPurucker merged commit 483f467 into develop Jun 17, 2025
5 of 13 checks passed
@LennartPurucker LennartPurucker deleted the uv_local_install branch June 17, 2025 15:30
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.

4 participants