Installation

Prerequisites

• Python ≥ 3.9, recommended version 3.11.1.
• Windows Terminal Terminal, accessed through the command line interface (CLI).
• Text editor with Python syntax support.
  • VSCode or VSCode Online is recommended.

F2 can be used alone or installed into an existing project. In both cases, you can select a different version to install using the following command:

Windows

$ pip install f2              # Latest version
$ pip install f2==x.x.x       # Specified version
$ pip install 'f2>=x.x.x'     # Minimum version

Linux

$ pip3 install f2              # Latest version
$ pip3 install f2==x.x.x       # Specified version
$ pip3 install 'f2>=x.x.x'     # Minimum version

MacOS

$ pip3 install f2              # Latest version
$ pip3 install f2==x.x.x       # Specified version
$ pip3 install 'f2>=x.x.x'     # Minimum version

Got a dependency or other warning?

If you are prompted with a python or pip version error, try updating to the required version.

If you have a slow network environment and cannot access the official mirrors properly. Please use a third-party mirror source that can be accessed properly.

Windows

$ pip install -i https://pypi.tuna.tsinghua.edu.cn/simple f2

Linux

$ pip3 install -i https://pypi.tuna.tsinghua.edu.cn/simple f2

MacOS

$ pip3 install -i https://pypi.tuna.tsinghua.edu.cn/simple f2

Tip

F2 is an asynchronous library, and developers should carefully read the documentation before calling methods.

For more details, see advance-guide.