diff --git a/docs/guides/projects.md b/docs/guides/projects.md index 55a2a2e32..a9cec80d0 100644 --- a/docs/guides/projects.md +++ b/docs/guides/projects.md @@ -1 +1,32 @@ -# Creating a project +# Working on projects + +## Creating a new project + +``` +uv init +``` + +### Working on an existing project + + + + +## Running commands + +``` +uv run +``` + +## Managing dependencies + +``` +uv add +``` + +``` +uv remove +``` + +## Next steps + +See the [projects concept](../projects.md) documentation for more details on projects. diff --git a/docs/preview/projects.md b/docs/preview/projects.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/projects.md b/docs/projects.md new file mode 100644 index 000000000..32e744b4d --- /dev/null +++ b/docs/projects.md @@ -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 + + + +## 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. diff --git a/mkdocs.template.yml b/mkdocs.template.yml index 5f8e16793..0586a9c7f 100644 --- a/mkdocs.template.yml +++ b/mkdocs.template.yml @@ -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