# Pipeless Core
[Pipeless](https://www.pipeless.ai) is a computer vision framework to quickly create and deploy applications that process real time streams. The Pipeless Core is the core component of the framework.
The Pipeless core is split into several components:
* `input`: Receives the media streams, demux and decode the streams.
* `worker`: Receives raw media frames, either audio or video frames, and processes them according to the user provided app
* `output`: Receives the processed raw media frames, encodes and mux them into the proper container format for the output protocol provided by the user
## System Dependencies
* **Gstreamer 1.20.3**. Verify with `gst-launch-1.0 --gst-version`. Installation instructions [here](https://gstreamer.freedesktop.org/documentation/installing/index.html?gi-language=python)
## Python dependencies
* Poetry: find the installation instructions [here](https://python-poetry.org/docs/#installation)
## Installation
```console
pip install pipeless-ai
```
## Development
To test your changes run the following command from the project root directory:
```console
python -m pipeless_ai.core <component> [app_file_path.py]
```
* `<component>` can be `input`, `worker`, `output`, or `all` (default)
* `app_path` is required for the `worker` component and must be the path to the `app.py` (including `app.py`)
For simplicity, it will load a mock configuration (hardcoded) at `src/pipeless/pipeless.py` that you can edit for your use case.
The hardcoded configuration will only be used when launching the components with the command above, it won't affect testing with the CLI.
In order to debug, you can set the configuration `log_level` to `DEBUG`.
If you find an error related to GStreamer and no useful information has been logged, try using the env var `GST_DEBUG=5` to enable GStreamer to debug logs. Refer to this [page](https://gstreamer.freedesktop.org/documentation/tutorials/basic/debugging-tools.html?gi-language=python) for more information about GStreamer debugging.
## Manual Testing
In order to test your changes, start the virtualenv:
```console
poetry shell
```
After that, go to the `cli` directory and run `poetry install` to install the `pipeless-ai-cli` (CLI) component.
Then go to the `core` directory and run `poetry install` to install the `pipeless-ai` module. This will override the upstream dependency from the CLI component to use your local one.
Verify your environment by ensuring the pipeless modules are pointing to your local directories instead of the PyPi public modules:
```console
pip list | grep pipeless
```
With that, you should be able to run `pipeless run` with your changes.
Raw data
{
"_id": null,
"home_page": "https://pipeless.ai",
"name": "pipeless-ai",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "multimedia,framework,artificial-intelligence,pipeline,developer-tools,computer-vision,image-processing",
"author": "Miguel Angel Cabrera Minagorri",
"author_email": "devgorri@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a1/35/918966a512ff46641b217e8169aba0c5df08017f63816379570a23e4c0e1/pipeless_ai-0.1.19.tar.gz",
"platform": null,
"description": "# Pipeless Core\n\n[Pipeless](https://www.pipeless.ai) is a computer vision framework to quickly create and deploy applications that process real time streams. The Pipeless Core is the core component of the framework.\n\nThe Pipeless core is split into several components:\n\n* `input`: Receives the media streams, demux and decode the streams.\n* `worker`: Receives raw media frames, either audio or video frames, and processes them according to the user provided app\n* `output`: Receives the processed raw media frames, encodes and mux them into the proper container format for the output protocol provided by the user\n\n## System Dependencies\n\n* **Gstreamer 1.20.3**. Verify with `gst-launch-1.0 --gst-version`. Installation instructions [here](https://gstreamer.freedesktop.org/documentation/installing/index.html?gi-language=python)\n\n## Python dependencies\n\n* Poetry: find the installation instructions [here](https://python-poetry.org/docs/#installation)\n\n## Installation\n\n```console\npip install pipeless-ai\n```\n\n## Development\n\nTo test your changes run the following command from the project root directory:\n\n```console\npython -m pipeless_ai.core <component> [app_file_path.py]\n```\n\n* `<component>` can be `input`, `worker`, `output`, or `all` (default)\n* `app_path` is required for the `worker` component and must be the path to the `app.py` (including `app.py`)\n\nFor simplicity, it will load a mock configuration (hardcoded) at `src/pipeless/pipeless.py` that you can edit for your use case.\nThe hardcoded configuration will only be used when launching the components with the command above, it won't affect testing with the CLI.\n\nIn order to debug, you can set the configuration `log_level` to `DEBUG`.\nIf you find an error related to GStreamer and no useful information has been logged, try using the env var `GST_DEBUG=5` to enable GStreamer to debug logs. Refer to this [page](https://gstreamer.freedesktop.org/documentation/tutorials/basic/debugging-tools.html?gi-language=python) for more information about GStreamer debugging.\n\n## Manual Testing\n\nIn order to test your changes, start the virtualenv:\n\n```console\npoetry shell\n```\n\nAfter that, go to the `cli` directory and run `poetry install` to install the `pipeless-ai-cli` (CLI) component.\nThen go to the `core` directory and run `poetry install` to install the `pipeless-ai` module. This will override the upstream dependency from the CLI component to use your local one.\n\nVerify your environment by ensuring the pipeless modules are pointing to your local directories instead of the PyPi public modules:\n\n```console\npip list | grep pipeless\n```\n\nWith that, you should be able to run `pipeless run` with your changes.",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "An open-source computer vision framework to create and deploy computer vision applications that scale in minutes",
"version": "0.1.19",
"project_urls": {
"Documentation": "https://github.com/pipeless-ai/pipeless",
"Homepage": "https://pipeless.ai",
"Repository": "https://github.com/pipeless-ai/pipeless"
},
"split_keywords": [
"multimedia",
"framework",
"artificial-intelligence",
"pipeline",
"developer-tools",
"computer-vision",
"image-processing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9ebdf6b6d2426f2251802a2674751aa85742ff0e9b3ba815af568779d2614275",
"md5": "f135f7e2c33f39624fc91d02d02d79f6",
"sha256": "97cf6fe37687fc73f02ea92ecf10838d75ea7a883dd45957f1d8c86430139b57"
},
"downloads": -1,
"filename": "pipeless_ai-0.1.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f135f7e2c33f39624fc91d02d02d79f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 35693,
"upload_time": "2023-11-02T12:42:21",
"upload_time_iso_8601": "2023-11-02T12:42:21.841581Z",
"url": "https://files.pythonhosted.org/packages/9e/bd/f6b6d2426f2251802a2674751aa85742ff0e9b3ba815af568779d2614275/pipeless_ai-0.1.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a135918966a512ff46641b217e8169aba0c5df08017f63816379570a23e4c0e1",
"md5": "c04d4376af2cbeb65b56d2c1f9d180a4",
"sha256": "bdc5876a6a8b752a78eb33721ea2b709170927d87670d558eb4d1db4faaa810d"
},
"downloads": -1,
"filename": "pipeless_ai-0.1.19.tar.gz",
"has_sig": false,
"md5_digest": "c04d4376af2cbeb65b56d2c1f9d180a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 29620,
"upload_time": "2023-11-02T12:43:36",
"upload_time_iso_8601": "2023-11-02T12:43:36.793040Z",
"url": "https://files.pythonhosted.org/packages/a1/35/918966a512ff46641b217e8169aba0c5df08017f63816379570a23e4c0e1/pipeless_ai-0.1.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-02 12:43:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pipeless-ai",
"github_project": "pipeless",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pipeless-ai"
}
JSON
