`pip install -e .[dev,doc,test]` in contributing documention wont work, is this a documentation error?

First Check

• I added a very descriptive title to this issue.
• I used the GitHub search to find a similar issue and didn’t find it.
• I searched the FastAPI documentation, with the integrated search.
• I already searched in Google “How to X in FastAPI” and didn’t find any information.
• I already read and followed all the tutorial in the docs and didn’t find an answer.
• I already checked if it is not related to FastAPI but to Pydantic.
• I already checked if it is not related to FastAPI but to Swagger UI.
• I already checked if it is not related to FastAPI but to ReDoc.

Commit to Help

• I commit to help with one of those options 👆

Example Code

pip install -e .[dev,doc,test]

Description

i am trying to execute upper command in my local python virtual env, and got error return:

Operating System

Linux

Operating System Details

DISTRIB_ID=Ubuntu DISTRIB_RELEASE=22.04 DISTRIB_CODENAME=jammy DISTRIB_DESCRIPTION=“Ubuntu 22.04.1 LTS”

FastAPI Version

0.85.0

Python Version

3.10.7

Additional Context

i cloned latest fastapi, trying to understand how to generate docs, when i follow the following documention: https://fastapi.tiangolo.com/contributing/

esp when running following cmd:

pip install -e .[dev,doc,test]

got following result

zsh: no matches found: .[dev,doc,test]

what should i do? is this a documentation error?

[JarroVGIT]

I just tested here locally, it doesn’t seem to work on zsh but it does work on bash. As the docs also say to use bash, I don’t think it’s an error in the docs.

For using zsh, try this command: pip install -e '.[dev,docs,test]'. The single quotes will ensure that zsh will not try to use the bit between the brackets for pattern matching but takes the brackets as literal brackets.

[JarroVGIT]

This answer on SO explains what .[test,dev,docs] does; it installs the optional dependencies in pyproject.toml.

It’s not a documentation error, FastAPI recently moved away from Flit, and this change was part of it. Can’t test it right now as I am on my phone, but maybe you can try it in bash rather than zsh?