# The ```pipepal``` repo
[![Build](https://github.com/sensein/pipepal/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/sensein/pipepal/actions/workflows/test.yaml?query=branch%3Amain)
[![codecov](https://codecov.io/gh/sensein/pipepal/branch/main/graph/badge.svg?token=MFU1LM80ET)](https://codecov.io/gh/sensein/pipepal)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![PyPI](https://img.shields.io/pypi/v/pipepal.svg)](https://pypi.org/project/pipepal/)
[![Python Version](https://img.shields.io/pypi/pyversions/pipepal)](https://pypi.org/project/pipepal)
[![License](https://img.shields.io/pypi/l/pipepal)](https://opensource.org/licenses/Apache-2.0)
[![pages](https://img.shields.io/badge/api-docs-blue)](https://sensein.github.io/pipepal)
Welcome to the ```pipepal``` repo! This is a Python package for streamlining the processing and analysis of behavioral data, such as voice and speech patterns, with robust and reproducible methodologies.
**Caution:**: this package is still under development and may change rapidly over the next few weeks.
## Features
- **Modular design**: Utilize a variety of task-specific transformations that can be easily integrated or used standalone, allowing for flexible data manipulation and analysis strategies.
- **Pre-built pipelines**: Access pre-configured pipelines combining multiple transformations tailored for common analysis tasks, which help in reducing setup time and effort.
- **Reproducibility**: Ensures consistent outputs through the use of fixed seeds and version-controlled processing steps, making your results verifiable and easily comparable.
- **Easy integration**: Designed to fit into existing workflows with minimal configuration, `pipepal` can be used alongside other data analysis tools and frameworks seamlessly.
- **Extensible**: Open to modifications and contributions, the package can be expanded with custom transformations and pipelines to meet specific research needs. <u>Do you want to contribute? Please, reach out!</u>
- **Comprehensive documentation**: Comes with detailed documentation for all features and modules, including examples and guides on how to extend the package for other types of behavioral data analysis.
- **Performance Optimized**: Efficiently processes large datasets with optimized code and algorithms, ensuring quick turnaround times even for complex analyses.
- **Interactive Examples**: Includes Jupyter notebooks that provide practical examples of how `pipepal` can be implemented to derive insights from real-world data sets.
Whether you're researching speech disorders, analyzing customer service calls, or studying communication patterns, `pipepal` provides the tools and flexibility needed to extract meaningful conclusions from your data.
## Installation
Install this package via:
```sh
pip install pipepal
```
Or get the newest development version via:
```sh
pip install git+https://github.com/sensein/pipepal.git
```
## Quick start
```Python
from pipepal.app import hello_world
hello_world()
```
## To do:
- [ ] Integrating more audio tasks and moving functions from b2aiprep package:
- [ ] data_augmentation
- [ ] data_representation
- [x] example_task
- [x] input_output
- [ ] raw_signal_processing
- [ ] speaker_diarization
- [ ] speech emotion recognition
- [ ] speech enhancement
- [ ] speech_to_text
- [ ] text_to_speech
- [ ] voice conversion
- [ ] Integrating more video tasks:
- [x] input_output
- [ ] Preparing some pipelines with pydra
- [ ] Populating the CLI
Raw data
{
"_id": null,
"home_page": "https://github.com/sensein/pipepal",
"name": "pipepal",
"maintainer": "Fabio Catania",
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": "fabiocat@mit.edu",
"keywords": "voice, speech, audio",
"author": "Fabio Catania",
"author_email": "fabiocat@mit.edu",
"download_url": "https://files.pythonhosted.org/packages/82/14/728c7e65d6555d86af10b91d8e771fa1760a83094735e78a95b31d26db7e/pipepal-0.1.4.tar.gz",
"platform": null,
"description": "# The ```pipepal``` repo\n\n[![Build](https://github.com/sensein/pipepal/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/sensein/pipepal/actions/workflows/test.yaml?query=branch%3Amain)\n[![codecov](https://codecov.io/gh/sensein/pipepal/branch/main/graph/badge.svg?token=MFU1LM80ET)](https://codecov.io/gh/sensein/pipepal)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n\n[![PyPI](https://img.shields.io/pypi/v/pipepal.svg)](https://pypi.org/project/pipepal/)\n[![Python Version](https://img.shields.io/pypi/pyversions/pipepal)](https://pypi.org/project/pipepal)\n[![License](https://img.shields.io/pypi/l/pipepal)](https://opensource.org/licenses/Apache-2.0)\n\n[![pages](https://img.shields.io/badge/api-docs-blue)](https://sensein.github.io/pipepal)\n\nWelcome to the ```pipepal``` repo! This is a Python package for streamlining the processing and analysis of behavioral data, such as voice and speech patterns, with robust and reproducible methodologies. \n\n**Caution:**: this package is still under development and may change rapidly over the next few weeks.\n\n## Features\n- **Modular design**: Utilize a variety of task-specific transformations that can be easily integrated or used standalone, allowing for flexible data manipulation and analysis strategies.\n\n- **Pre-built pipelines**: Access pre-configured pipelines combining multiple transformations tailored for common analysis tasks, which help in reducing setup time and effort.\n\n- **Reproducibility**: Ensures consistent outputs through the use of fixed seeds and version-controlled processing steps, making your results verifiable and easily comparable.\n\n- **Easy integration**: Designed to fit into existing workflows with minimal configuration, `pipepal` can be used alongside other data analysis tools and frameworks seamlessly.\n\n- **Extensible**: Open to modifications and contributions, the package can be expanded with custom transformations and pipelines to meet specific research needs. <u>Do you want to contribute? Please, reach out!</u>\n\n- **Comprehensive documentation**: Comes with detailed documentation for all features and modules, including examples and guides on how to extend the package for other types of behavioral data analysis.\n\n- **Performance Optimized**: Efficiently processes large datasets with optimized code and algorithms, ensuring quick turnaround times even for complex analyses.\n\n- **Interactive Examples**: Includes Jupyter notebooks that provide practical examples of how `pipepal` can be implemented to derive insights from real-world data sets.\n\nWhether you're researching speech disorders, analyzing customer service calls, or studying communication patterns, `pipepal` provides the tools and flexibility needed to extract meaningful conclusions from your data.\n\n\n## Installation\nInstall this package via:\n\n```sh\npip install pipepal\n```\n\nOr get the newest development version via:\n\n```sh\npip install git+https://github.com/sensein/pipepal.git\n```\n\n## Quick start\n```Python\nfrom pipepal.app import hello_world\n\nhello_world()\n```\n\n## To do:\n- [ ] Integrating more audio tasks and moving functions from b2aiprep package:\n - [ ] data_augmentation \n - [ ] data_representation\n - [x] example_task\n - [x] input_output\n - [ ] raw_signal_processing\n - [ ] speaker_diarization\n - [ ] speech emotion recognition\n - [ ] speech enhancement\n - [ ] speech_to_text\n - [ ] text_to_speech\n - [ ] voice conversion\n- [ ] Integrating more video tasks:\n - [x] input_output\n\n- [ ] Preparing some pipelines with pydra\n- [ ] Populating the CLI\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "PipePal is a Python package that simplifies building pipelines for speech and voice analysis.",
"version": "0.1.4",
"project_urls": {
"Documentation": "https://sensein.github.io/pipepal",
"Homepage": "https://github.com/sensein/pipepal",
"Repository": "https://github.com/sensein/pipepal"
},
"split_keywords": [
"voice",
" speech",
" audio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "95741ab391cb3d411e3e5fa45065f5ce388dfdd6f8141bf422fb7ec372de5f53",
"md5": "4a1cd6e483ce1dfecfcf869d94656b73",
"sha256": "e692c94db93b970fdb4d07657f1cbe1197c88d0e5f2cf7d07c5dd2d2079e72bd"
},
"downloads": -1,
"filename": "pipepal-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4a1cd6e483ce1dfecfcf869d94656b73",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 40225,
"upload_time": "2024-04-12T18:34:29",
"upload_time_iso_8601": "2024-04-12T18:34:29.919386Z",
"url": "https://files.pythonhosted.org/packages/95/74/1ab391cb3d411e3e5fa45065f5ce388dfdd6f8141bf422fb7ec372de5f53/pipepal-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8214728c7e65d6555d86af10b91d8e771fa1760a83094735e78a95b31d26db7e",
"md5": "b002b5084e1573c5c180d168eacf4afb",
"sha256": "c19f08a15453a9d254d293c50a177951e2a1a95ac34aa0c0b1a5849035fb96d5"
},
"downloads": -1,
"filename": "pipepal-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "b002b5084e1573c5c180d168eacf4afb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 23949,
"upload_time": "2024-04-12T18:34:31",
"upload_time_iso_8601": "2024-04-12T18:34:31.876650Z",
"url": "https://files.pythonhosted.org/packages/82/14/728c7e65d6555d86af10b91d8e771fa1760a83094735e78a95b31d26db7e/pipepal-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-12 18:34:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sensein",
"github_project": "pipepal",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pipepal"
}