Skip to main content

Stub code, type definitions and documentation for the FL Studio Python API

Project description

FL Studio API Stubs

This repository contains stub code for functions and classes used in FL Studio's Python API. This includes modules used for

Usage

This documentation can be viewed online, or accessed by installing the package from Python's package manager Pip.

For instructions, please visit the documentation website.

Contributing

We'd love to have your help maintaining this project.

Feature requests and bugs

If you'd like to report a bug in FL Studio, or get new features added to FL Studio's Python API, please create a post on the Image-Line forum. The issues tab for this repository should only be used for reporting issues with the stub code.

Issues with the API

If you've spotted an issue with the API documentation or stub code, please open an issue and we'll get it fixed up as soon as we can. In particular, we're on the look out for:

  • Incorrect type definitions
  • Missing functions or constants
  • Confusing, missing or poorly-formatted documentation

Setting up a development environment

Dependencies for this project are managed using Poetry. You'll need to install Poetry to contribute to the project.

To install dependencies for the project:

# Install dependencies for the project
poetry install --no-root
# Run the pre-build script
poetry run python -m scripts.build_lib
# Install the library
poetry install

Whenever you modify documentation, you will need to rerun the pre-build script for your changes to be persisted.

Developing the documentation site

You can trigger a build of the documentation site by running:

poetry run python -m scripts.build_docs

If you are using the VS Code text editor, we recommend using the Live Server Extension to serve the documentation site, since it automatically refreshes the page whenever you run the build command. Additionally, VS Code will automatically run this build command when you press Ctrl+Shift+B.

Understanding the repository layout

In order to ensure that the documentation is of the highest quality, both online and in library form, the layout is a little complex.

  • src/ contains the source code for all included modules, divided up based on whether they are a component of MIDI Controller Scripting, Edison Scripting, or Piano Roll Scripting. Each Python file contains function definitions, with docstrings showing their behaviour.

  • docs/ contains Markdown files and other assets used when building the online documentation. This is merged with the layout of src/ when building documentation, so the resultant site ends up containing the documentation from both directories.

    • .pages files within the docs/ directory contain a YAML listing for the navigation of this section of the documentation. They are used to re-order and rename elements within the navigation pane of the documentation site.
  • scripts/ contains Python scripts for performing common actions such as building the documentation or building the package.

  • data/ contains other assets used by the repository, such as Transdoc rule definitions, and docstring templates.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fl_studio_api_stubs-37.0.1.tar.gz (93.9 kB view details)

Uploaded Source

Built Distribution

fl_studio_api_stubs-37.0.1-py3-none-any.whl (129.3 kB view details)

Uploaded Python 3

File details

Details for the file fl_studio_api_stubs-37.0.1.tar.gz.

File metadata

  • Download URL: fl_studio_api_stubs-37.0.1.tar.gz
  • Upload date:
  • Size: 93.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.4 Windows/10

File hashes

Hashes for fl_studio_api_stubs-37.0.1.tar.gz
Algorithm Hash digest
SHA256 e1f3e94d4d115fb2089804ad18166bb6b76dcd54ecd7548f77d6f2af29d5b0b4
MD5 7d4a8b6a76928b3dd2372fec6cb563f8
BLAKE2b-256 93e7c470761a5ba476dc3365876780685d9873ac3d7ec77b7dc7422b3e1388f3

See more details on using hashes here.

Provenance

File details

Details for the file fl_studio_api_stubs-37.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for fl_studio_api_stubs-37.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 34725b81859edd3d424aa74f0673c1874b26bee33af32c513189792fed2cd1b7
MD5 e9a1c2bcdb02c7537f35ac96c7a1403e
BLAKE2b-256 dfc4a6f05ea624928dbb263e3e500a30679b885429f6146645f0065656943810

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page