mirror of https://github.com/astral-sh/uv
Add stubs for the project documentation (#5135)
@ibraheemdev is going to do some work on these, I just sketched out some parts to try to understand how things will fit together.
This commit is contained in:
parent
426736f7ed
commit
177bbaa8c0
|
|
@ -1 +1,32 @@
|
|||
# Creating a project
|
||||
# Working on projects
|
||||
|
||||
## Creating a new project
|
||||
|
||||
```
|
||||
uv init
|
||||
```
|
||||
|
||||
### Working on an existing project
|
||||
|
||||
<!-- What makes a project compatible with uv commands? What are my alternatives? -->
|
||||
|
||||
|
||||
## Running commands
|
||||
|
||||
```
|
||||
uv run
|
||||
```
|
||||
|
||||
## Managing dependencies
|
||||
|
||||
```
|
||||
uv add
|
||||
```
|
||||
|
||||
```
|
||||
uv remove
|
||||
```
|
||||
|
||||
## Next steps
|
||||
|
||||
See the [projects concept](../projects.md) documentation for more details on projects.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,55 @@
|
|||
# Projects
|
||||
|
||||
## Project metadata
|
||||
|
||||
`pyproject.toml`
|
||||
|
||||
```
|
||||
uv init
|
||||
```
|
||||
|
||||
## Project environments
|
||||
|
||||
`.venv`
|
||||
|
||||
```
|
||||
uv sync
|
||||
```
|
||||
|
||||
## Lock files
|
||||
|
||||
```
|
||||
uv lock
|
||||
```
|
||||
|
||||
## Adding dependencies
|
||||
|
||||
```
|
||||
uv add
|
||||
```
|
||||
|
||||
### Updating existing dependencies
|
||||
|
||||
<!-- What happens when the same dependency is added multiple times? -->
|
||||
|
||||
## Removing dependencies
|
||||
|
||||
```
|
||||
uv remove
|
||||
```
|
||||
|
||||
## Running commands
|
||||
|
||||
```
|
||||
uv run
|
||||
```
|
||||
|
||||
### Running commands with additional dependencies
|
||||
|
||||
### Running scripts
|
||||
|
||||
Scripts that declare inline metadata are automatically executed in environments isolated from the project. See the [scripts guide](./guides/scripts.md#declaring-script-dependencies) for more details.
|
||||
|
||||
## Projects with many packages
|
||||
|
||||
See the [workspaces](./preview/workspaces.md) documentation.
|
||||
|
|
@ -75,9 +75,9 @@ nav:
|
|||
- Installing Python: guides/install-python.md
|
||||
- Running scripts: guides/scripts.md
|
||||
- Using tools: guides/tools.md
|
||||
- Creating a project: guides/projects.md
|
||||
- Working on projects: guides/projects.md
|
||||
- Concepts:
|
||||
- Projects: preview/projects.md
|
||||
- Projects: projects.md
|
||||
- Command-line tools: preview/tools.md
|
||||
- Python versions: python-versions.md
|
||||
- Workspaces: preview/workspaces.md
|
||||
|
|
|
|||
Loading…
Reference in New Issue