Skip to content

Conversation

@jonavellecuerdo
Copy link
Contributor

Purpose and background context

Migrate Python CLI template to uv

How can a reviewer manually see the effects of these changes?

The uv-based GitHub CI workflow has been tested in MITLibraries/timdex-embeddings#33

Includes new or updated dependencies?

YES

Changes expectations for external applications?

NO

What are the relevant tickets?

Code review

  • Code review best practices are documented here and you are encouraged to have a constructive dialogue with your reviewers about their preferences and expectations.

@jonavellecuerdo jonavellecuerdo requested review from a team, ehanson8 and ghukill January 16, 2026 15:46
@jonavellecuerdo
Copy link
Contributor Author

Question for @ehanson8 and @ghukill : Should we exclude the uv.lock file similar to how we excluded the Pipfile.lock so as to avoid pinning dependencies for the template?

Why these changes are being introduced:

This is the first pass in migrating to uv from pipenv.

How this addresses that need:
* Removes Pipfile and Pipfile.lock
* Updates pyproject.toml to be a valid uv project
* All dependencies handled via 'uv add' and exist in pyproject.toml
* Makefile and pre-commits updated to use uv syntax
* Github actions *temporarily* hardcoded in local workflows, with
a TODO to move these to a shared workflow when things settle down
* Bumps python to 3.13

Side effects of this change:
* Many!  Hard pivot from Pipenv installation and running of the
application.

At this time, the largest side effect is the loss of
'pipenv run <appname>'.  A future commit will apply a new
strategy, but that is not present now.  A workaround is
'uv run my_app/cli.py`.

Relevant ticket(s):
* https://mitlibraries.atlassian.net/browse/IN-1425
Why these changes are being introduced:

As we continue to slowly build out this uv driven version
of the CLI template, finding little things to update along
the way.

How this addresses that need:
* Updated Dockerfile to use uv in image build
* Add convenience docker methods in Makefile, unassociated
with AWS ECR (helpful for local testing)
* Update dependencies

Side effects of this change:
* None

Relevant ticket(s):
* None
@coveralls
Copy link

coveralls commented Jan 16, 2026

Pull Request Test Coverage Report for Build 21072504558

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%

Totals Coverage Status
Change from base Build 17270497594: 0.0%
Covered Lines: 35
Relevant Lines: 35

💛 - Coveralls

@ehanson8 ehanson8 self-assigned this Jan 16, 2026
@ehanson8
Copy link
Contributor

Question for @ehanson8 and @ghukill : Should we exclude the uv.lock file similar to how we excluded the Pipfile.lock so as to avoid pinning dependencies for the template?

We don't seem to be excluding Pipfile.lock here, was that a recent decision?

Copy link
Contributor

@ehanson8 ehanson8 left a comment

Choose a reason for hiding this comment

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

Looking good but a few questions and comments


COPY Pipfile* /
RUN pipenv install
# Install package into system python, includes "marimo-launcher" script
Copy link
Contributor

Choose a reason for hiding this comment

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

This docstring probably shouldn't have the marimo-launcher reference

# Docker
####################################
docker-build: # Build local image for testing
docker build -t python-cli-template:latest .
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a reason this is python-cli-template rather than my-app? It would simplify the find/replace if they were the same

# https://mitlibraries.atlassian.net/wiki/spaces/IN/pages/3432415247/Python+Project+Linters#Template-for-pyproject.toml

[project]
name = "python-cli-template"
Copy link
Contributor

Choose a reason for hiding this comment

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

Again, could this be my-app?

[project]
name = "python-cli-template"
version = "2.0.0"
requires-python = ">=3.12"
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we want ~=3.12.0 rather than >=3.12 to avoid inadvertently upgrading to 3.13, ~=3.12.0 keeps it in 3.12 but gets the newest patch version

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.

5 participants