# FL Studio Python API Stubs
This project contains function definitions to provide intellisense while
working on scripts for FL Studio's Python API, as well as a partially-complete
model of FL Studio, which allows for scripts to be tested outside of FL Studio.
## Online Reference
The documentation is also available as an
[online reference](https://miguelguthridge.github.io/FL-Studio-API-Docs) if
Image-Line's own documentation isn't up to scratch.
## Installation
To avoid module conflicts with other Python projects, it is recommended that
you install this script in a virtual environment by following
[these instructions](https://docs.python.org/3/library/venv.html) in the
official Python documentation.
After activating the environment in your editor, you can install the stub
modules by running the command `pip install FL-Studio-API-Stubs` on Windows or
`pip3 install FL-Studio-API-Stubs` on MacOS or Linux.
[Video reference for installation instructions](https://youtu.be/6_KdXJIfeoI)
## Testing using the FL Studio API Stubs
This code provides a model of FL Studio which can be used to test basic
functionality of projects using the API. The [fl_model](./src/fl_model/) module can be used for
controlling the state of the model. Refer to its documentation for usage
instructions.
## The Small Print
A couple of notes regarding this repo.
### This Documentation isn't Complete
Although the stubs are mostly complete, there are a few functions where I don't
fully understand how they work. These functions have a `HELP WANTED:` label in
their documentation. If you happen to know how to use one, I'd love it if you
helped out by improving the documentation! I may also have incorrect
definitions for some functions. Please
[create an issue](https://github.com/MiguelGuthridge/FL-Studio-API-Stubs/issues/new)
if you find anything incorrect.
### Differences to the Official Implementation
A small number of tweaks have been made to these stubs in order to ease code
writing. These shouldn't have any functional impact on the behavior of the API
compared to the implied behavior from the stubs, but should help clarify some
properties of certain functions.
* Functions where parameters or returns are boolean by nature are listed as
using a `bool` type, even though the implementation uses the integers `0` and
`1`. This change should help to describe the context in which the functions
should be called when writing scripts, which in a language like Python is far
more important than the actual implementation of the functions.
Raw data
{
"_id": null,
"home_page": "https://github.com/MiguelGuthridge/FL-Studio-Api-Stubs",
"name": "FL-Studio-API-Stubs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9.1",
"maintainer_email": "",
"keywords": "fl-studio,midi,api,documentation,stubs,fl,studio,daw",
"author": "Miguel Guthridge",
"author_email": "hdsq@outlook.com.au",
"download_url": "https://files.pythonhosted.org/packages/bb/29/13df5cae2b76612a06f65ff7c43d2d80bdca3336c49c005f33c6d4ab6842/FL_Studio_API_Stubs-24.0.0.tar.gz",
"platform": null,
"description": "# FL Studio Python API Stubs\n\nThis project contains function definitions to provide intellisense while\nworking on scripts for FL Studio's Python API, as well as a partially-complete\nmodel of FL Studio, which allows for scripts to be tested outside of FL Studio.\n\n## Online Reference\n\nThe documentation is also available as an\n[online reference](https://miguelguthridge.github.io/FL-Studio-API-Docs) if\nImage-Line's own documentation isn't up to scratch.\n\n## Installation\n\nTo avoid module conflicts with other Python projects, it is recommended that\nyou install this script in a virtual environment by following\n[these instructions](https://docs.python.org/3/library/venv.html) in the\nofficial Python documentation.\n\nAfter activating the environment in your editor, you can install the stub\nmodules by running the command `pip install FL-Studio-API-Stubs` on Windows or\n`pip3 install FL-Studio-API-Stubs` on MacOS or Linux.\n\n[Video reference for installation instructions](https://youtu.be/6_KdXJIfeoI)\n\n## Testing using the FL Studio API Stubs\n\nThis code provides a model of FL Studio which can be used to test basic\nfunctionality of projects using the API. The [fl_model](./src/fl_model/) module can be used for\ncontrolling the state of the model. Refer to its documentation for usage\ninstructions.\n\n## The Small Print\n\nA couple of notes regarding this repo.\n\n### This Documentation isn't Complete\n\nAlthough the stubs are mostly complete, there are a few functions where I don't\nfully understand how they work. These functions have a `HELP WANTED:` label in\ntheir documentation. If you happen to know how to use one, I'd love it if you\nhelped out by improving the documentation! I may also have incorrect\ndefinitions for some functions. Please\n[create an issue](https://github.com/MiguelGuthridge/FL-Studio-API-Stubs/issues/new)\nif you find anything incorrect.\n\n### Differences to the Official Implementation\n\nA small number of tweaks have been made to these stubs in order to ease code\nwriting. These shouldn't have any functional impact on the behavior of the API\ncompared to the implied behavior from the stubs, but should help clarify some\nproperties of certain functions.\n\n* Functions where parameters or returns are boolean by nature are listed as\n using a `bool` type, even though the implementation uses the integers `0` and\n `1`. This change should help to describe the context in which the functions\n should be called when writing scripts, which in a language like Python is far\n more important than the actual implementation of the functions.\n",
"bugtrack_url": null,
"license": "",
"summary": "Module and function definitions and documentation for the FL Studio Python API",
"version": "24.0.0",
"split_keywords": [
"fl-studio",
"midi",
"api",
"documentation",
"stubs",
"fl",
"studio",
"daw"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b641b6fc84694e759c05e3abf0a596c631bf94f6e67e179f7535b9cd00c3c15a",
"md5": "dc3e5e16b1aead9649bf599064562991",
"sha256": "f54cc74e8d03b1fcefd61dd9df4422febca91a0c87f2b9c07d00f5e316386b96"
},
"downloads": -1,
"filename": "FL_Studio_API_Stubs-24.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dc3e5e16b1aead9649bf599064562991",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.1",
"size": 101341,
"upload_time": "2023-01-24T04:46:25",
"upload_time_iso_8601": "2023-01-24T04:46:25.843440Z",
"url": "https://files.pythonhosted.org/packages/b6/41/b6fc84694e759c05e3abf0a596c631bf94f6e67e179f7535b9cd00c3c15a/FL_Studio_API_Stubs-24.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bb2913df5cae2b76612a06f65ff7c43d2d80bdca3336c49c005f33c6d4ab6842",
"md5": "93ddec57488cf9eae07c6ab805517401",
"sha256": "db0147695c1abb8f2286153de421adecd8a0fd617037a78b3b76d939ddd58ce2"
},
"downloads": -1,
"filename": "FL_Studio_API_Stubs-24.0.0.tar.gz",
"has_sig": false,
"md5_digest": "93ddec57488cf9eae07c6ab805517401",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.1",
"size": 76977,
"upload_time": "2023-01-24T04:46:27",
"upload_time_iso_8601": "2023-01-24T04:46:27.257820Z",
"url": "https://files.pythonhosted.org/packages/bb/29/13df5cae2b76612a06f65ff7c43d2d80bdca3336c49c005f33c6d4ab6842/FL_Studio_API_Stubs-24.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-24 04:46:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "MiguelGuthridge",
"github_project": "FL-Studio-Api-Stubs",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "fl-studio-api-stubs"
}
JSON
