Write project guide #5195
Write project guide #5195
Conversation
ibraheemdev
added
documentation
ibraheemdev
requested review from
zanieb and
charliermarsh
and removed request for
zanieb
ibraheemdev
force-pushed
the
ibraheem/project-guide
branch
from
76ec686
to
d3d3c17
Compare
| ├── uv.lock | ||
| └── src | ||
| └── hello-world | ||
| └── __init__.py |
There was a problem hiding this comment.
This is assuming that uv init creates the venv and lockfile. I found that this made it a little easier to explain things than having a distinction between "the things that are created by uv init" and "the things that are created the first time you execute uv run".
There was a problem hiding this comment.
I think it's fine to create them both personally. Maybe we just want an opt-out flag?
ibraheemdev
force-pushed
the
ibraheem/project-guide
branch
2 times, most recently
from
b000cf8
to
8029892
Compare
ibraheemdev
force-pushed
the
ibraheem/project-guide
branch
from
8029892
to
2b0ec44
Compare
| @@ -1,32 +1,136 @@ | |||
| # Working on projects | |||
|
|
|||
| uv can manage the development of a Python project from the ground up. | |||
There was a problem hiding this comment.
Feel like we need a better tagline here.
There was a problem hiding this comment.
Maybe just define a project e.g.: uv is capable of managing projects using the pyproject.toml standard.
docs/guides/projects.md
Outdated
|
|
||
| ### `uv.lock` | ||
|
|
||
| `uv.lock` is a lockfile that contains exact information about your project's |
There was a problem hiding this comment.
Are we recommending to check this in to VCS (does that depend on application vs. library)?
There was a problem hiding this comment.
I think it should always be checked into VCS
Summary
Write the project guide that was added in #5135.
I tried to expand on details as much as I felt was necessary for someone new to python package managers (which was myself a couple months ago).