Skip to content

docs: Add uv guide#932

Open
vdusek wants to merge 6 commits into
masterfrom
docs/uv-guide
Open

docs: Add uv guide#932
vdusek wants to merge 6 commits into
masterfrom
docs/uv-guide

Conversation

@vdusek
Copy link
Copy Markdown
Contributor

@vdusek vdusek commented Jun 3, 2026

Adds a "Manage your project with uv" guide covering the whole Actor lifecycle with the uv package and project manager: creating a project, the Actor scaffolding, running locally, installing the locked dependencies in the Dockerfile, deploying, and day-to-day dependency management.

  • docs/03_guides/10_uv.mdx — the guide.
  • docs/03_guides/code/uv_project/ — the backing example project, covered by the repo lint and type checks.
  • Quick-start guides list updated.

The documented flow was verified end to end (local apify run + a real Docker build/run). Since the Actor templates are pip-only for now, the guide carries an info banner pointing to apify/actor-templates#350. Companion template PR: apify/actor-templates#800.

TODO before merging: clone the guide content (docs/03_guides/10_uv.mdx + docs/03_guides/code/uv_project/) into website/versioned_docs/version-3.4/ so it also shows in the current docs version, not only under "next".

Add a new guide on managing Actor projects with the uv package manager,
covering project setup, local development with the Apify CLI, the uv-based
Dockerfile, deployment, and dependency management.
@vdusek vdusek requested a review from szaganek as a code owner June 3, 2026 17:57
@vdusek vdusek added adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. labels Jun 3, 2026
@vdusek vdusek self-assigned this Jun 3, 2026
@vdusek vdusek added adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. labels Jun 3, 2026
@github-actions github-actions Bot added this to the 142nd sprint - Tooling team milestone Jun 3, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.98%. Comparing base (b7ba52d) to head (560cc43).
⚠️ Report is 7 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #932      +/-   ##
==========================================
+ Coverage   86.94%   86.98%   +0.03%     
==========================================
  Files          48       48              
  Lines        2942     2942              
==========================================
+ Hits         2558     2559       +1     
+ Misses        384      383       -1     
Flag Coverage Δ
e2e 37.76% <ø> (+0.20%) ⬆️
integration 59.14% <ø> (+0.23%) ⬆️
unit 75.69% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@vdusek vdusek marked this pull request as draft June 3, 2026 18:00
@vdusek vdusek removed the request for review from szaganek June 3, 2026 18:00
…n uv guide

The scaffolding section referenced a Dockerfile that is only created later in
the guide, which was confusing without a pointer. The local run example also
used the optional --purge flag, which is not needed for the tutorial flow.
@vdusek vdusek marked this pull request as ready for review June 3, 2026 18:22
"Use uv" was too terse - unlike the scraping-library guides, the tool name
alone does not convey the guide's purpose. The new title mirrors the guide's
intro sentence and the verb-first sidebar convention.
@vdusek vdusek added the documentation Improvements or additions to documentation. label Jun 3, 2026
@vdusek vdusek requested review from Mantisus and szaganek June 3, 2026 18:25
@vdusek
Copy link
Copy Markdown
Contributor Author

vdusek commented Jun 3, 2026

It would be great if @Mantisus could review the overall Python correctness (and factual accuracy?), and @szaganek could review the content. Thank you guys 🙂.

Comment thread docs/03_guides/code/uv_project/Dockerfile
The guide pointed readers to a python-uv template that isn't published. An
info banner now explains templates are pip-only for now and links the
tracking issue apify/actor-templates#350.
Copy link
Copy Markdown
Collaborator

@Mantisus Mantisus left a comment

Choose a reason for hiding this comment

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

Just a few points

Comment thread docs/03_guides/08_uv.mdx Outdated
Comment thread docs/03_guides/08_uv.mdx Outdated
Comment thread docs/03_guides/code/uv_project/pyproject.toml Outdated
@vdusek vdusek requested a review from Mantisus June 4, 2026 07:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. documentation Improvements or additions to documentation. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants