Skip to content

docs: recommend uv instead of pipx for running/installing#957

Open
gdubicki wants to merge 1 commit intomainfrom
remove-pipx-recommendation
Open

docs: recommend uv instead of pipx for running/installing#957
gdubicki wants to merge 1 commit intomainfrom
remove-pipx-recommendation

Conversation

@gdubicki
Copy link
Copy Markdown
Member

as it handles Python upgrades automatically, while pipx may keep you stuck with the existing, old version of Python (unless I am missing something)

It's also the ✨shiny new thing✨

@gdubicki gdubicki temporarily deployed to Integrate Pull Request February 15, 2025 14:58 — with GitHub Actions Inactive
@gdubicki gdubicki temporarily deployed to Integrate Pull Request February 15, 2025 14:58 — with GitHub Actions Inactive
@codecov
Copy link
Copy Markdown

codecov bot commented Feb 15, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.63%. Comparing base (5bb6f4d) to head (807cb33).

❗ There is a different number of reports uploaded between BASE (5bb6f4d) and HEAD (807cb33). Click for more details.

HEAD has 3 uploads less than BASE
Flag BASE (5bb6f4d) HEAD (807cb33)
unittests 2 1
integration 3 1
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #957      +/-   ##
==========================================
- Coverage   87.67%   82.63%   -5.04%     
==========================================
  Files          73       73              
  Lines        3433     3433              
==========================================
- Hits         3010     2837     -173     
- Misses        423      596     +173     
Flag Coverage Δ
integration 79.05% <ø> (-6.68%) ⬇️
unittests 37.83% <ø> (ø)
see 16 files with indirect coverage changes
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

@jimisola jimisola left a comment

Choose a reason for hiding this comment

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

I was waiting with this changes until we moved to gitlab.com as I think I mentioned in the TODO/priority list in our maintainer chat.

I only see changes in the docs not in the CI/CD. I think that it's essential to use the same build and package tools in CI/CD as we recommend in our docs. How many of us have tested with uv? Just so that we don't recommend something that there might be issues with.

Also see a value as not freeze these type of changes, CI/CD etc, until the move to gitlab.com so that we don't have to continue to make changes to the GitLab CI/CD that @TimKnight-DWP has worked with.

Once moved to gitlab.com, I'm all for uv and a move to hatch (as per previous chat).

Copy link
Copy Markdown
Collaborator

@amimas amimas left a comment

Choose a reason for hiding this comment

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

Sounds interesting, although I'm not really familiar with uv yet. Will try to learn it sometime. If this looks good to you, please feel free to merge.

One question: if we're instructing uv for local dev, why don't we use that in the CI too?

* [uv](https://github.com/astral-sh/uv):
```shell
pipx run --spec 'gitlabform>=3,<4' gitlabform
uvx --from 'gitlabform>=3,<4' gitlabform
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This isn't really about uv. Looks like we already had constraint about gitlabform version being lower than 4. Not really familiar with either commands or what it's for. Should this be changed, now that we're already on version 4? But... what's the point of having a constraint? If we don't specify it, will it automatically install the latest one?

@gdubicki
Copy link
Copy Markdown
Member Author

Hey @jimisola and @amimas!

I created this as I noticed that pipx upgrade gitlabform doesn't correctly upgrade my install of the app because it was keeping using Python 3.11 for it and obviously gitlabform v4 is not available for it.

As I was reading about the fixes to update the docs I could really find a good one :/, that's why I suggested this change.

I didn't want to change to dev/CI/CD solution yet as I didn't use uv enough yet to do that.

Anyway, we don't need to move forward with this yet, we can wait for the move to gitlab.com first.

@jimisola
Copy link
Copy Markdown
Contributor

Ok. I think that we shall wait until the move to gitlab.com. There are a couple of things that I think that we should do at the same time.

@gdubicki gdubicki force-pushed the remove-pipx-recommendation branch from 0465db2 to 8fd8d92 Compare February 17, 2025 12:37
@gdubicki gdubicki had a problem deploying to Integrate Pull Request February 17, 2025 12:37 — with GitHub Actions Failure
@gdubicki gdubicki had a problem deploying to Integrate Pull Request February 17, 2025 12:37 — with GitHub Actions Failure
as it handles Python upgrades automatically, while pipx may keep you stuck
with the existing, old version of Python (unless I am missing something)

It's also the ✨shiny new thing✨
@TimKnight01 TimKnight01 force-pushed the remove-pipx-recommendation branch from 8fd8d92 to 807cb33 Compare September 18, 2025 08:12
@TimKnight01 TimKnight01 had a problem deploying to Integrate Pull Request September 18, 2025 08:12 — with GitHub Actions Failure
@TimKnight01 TimKnight01 had a problem deploying to Integrate Pull Request September 18, 2025 08:12 — with GitHub Actions Failure
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