How to Install the FL Studio Python API Stubs

Описание

Working with the FL Studio Python API can be a challenge, since most editors, including VS Code, won't provide any auto-completions or inline documentation for the FL Studio modules. Fortunately, I've created a library of stub functions, which can provide all of this useful information, directly in your editor of choice.

To do this tutorial, you'll need to have a reasonably modern version of Python installed to your system (3.9 and up). Get one from https://www.python.org/downloads/ or from your package manager of choice.

Project GitHub Repository:
https://github.com/MiguelGuthridge/FL-Studio-API-Stubs/

Unofficial Online API Documentation:
https://miguelguthridge.github.io/FL-Studio-API-Stubs/

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Commands used:

Creating a virtual environment:
Windows: python -m venv .venv
MacOS and Linux: python3 -m venv .venv

Installing the library:
Windows: pip install fl-studio-api-stubs
MacOS and Linux: pip3 install fl-studio-api-stubs

Listing the requirements:
Make sure to use an angle bracket, which sadly isn't allowed in the description.
Windows: pip freeze [closing angle bracket] requirements.txt
MacOS and Linux: pip3 freeze [closing angle bracket] requirements.txt

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

A overview of virtual environments:
https://docs.python.org/3/tutorial/venv.html

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

All elements used in this video are either made by me, or are used under
creative commons or fair use.