mirror of
https://github.com/astral-sh/uv.git
synced 2025-10-17 13:58:29 +00:00
0ceefb3c88
## Summary - Fixed the directory structure and commands for the second scenario #6833 - Added a headline "Migrating an existing FastAPI project" because the first part looks like a migration scenario, but didn't have its own section before. - Added explicit `--app` flags to commands to emphasize that the commands create an Application project. Although maybe unnecessary considering that `--app` is now default. - Added instructions for testing that the dev server and Docker image work correctly - Took the liberty of adding a `project` at the root of all directory structures and appropriate commands. - With explicitly defined root directory it is easier to differentiate between the `project` root directory and FastAPI's `app` directory. - Without it it could be less obvious for developers less familiar with FastAPI. Had a similar issue when started using Django several years ago. - If I left `app` in the command, then after copying the **app directory** from https://github.com/astral-sh/uv-fastapi-example the path would be `app/app/...`. - Cleaned up glyphs in tree sctructures that were copied from FastAPI docs. ## Caveats - On project initialization `hello.py` is created. It is not reflected in directory structure trees in this PR and may be slightly confusing for developers less familiar with uv. - I believe it will be soon addressed in #6750 and after that the docs will reflect actual directory structure. |
||
|---|---|---|
| .. | ||
| integration | ||
| index.md | ||
| install-python.md | ||
| projects.md | ||
| publish.md | ||
| scripts.md | ||
| tools.md | ||