| Name | pellipop JSON |
| Version |
0.9.1
JSON |
| download |
| home_page | None |
| Summary | A graphical and command-line tool to extract key frames from videos along with their retranscription. It uses the Whisper API to transcribe the audio. It also generates a CSV file with the extracted key frames and their corresponding text. |
| upload_time | 2024-07-23 13:49:34 |
| maintainer | None |
| docs_url | None |
| author | EdouardBoute |
| requires_python | >=3.10 |
| license | None |
| keywords |
stt
frame
keyframes
panoptic
speech
speech-to-text
transcription
video
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Pellipop
[](https://pypi.org/project/pellipop)
[](https://pypi.org/project/pellipop)
This readme is also available in [English](https://github.com/CERES-Sorbonne/Pellipop/blob/master/readme_en.md)
## Table des matières
1. [Description](#description)
2. [Installation](#installation)
1. [PyPi](#pypi)
2. [Exécutable](#exécutable)
3. [Développement](#développement)
3. [Usage](#usage)
1. [Interface graphique](#interface-graphique)
2. [Ligne de commande](#ligne-de-commande)
4. [License](#license)
## Description
Pellipop est un outil de découpe de vidéos en images fixes, avec extraction de texte et audio.
Il permet de découper des vidéos en images fixes, en extrayant le texte et l'audio des vidéos.
Il permet également d'obtenir un fichier csv contenant les informations des images extraites et facilitant l'exportation
des données dans des logiciels de traitement de corpus d'image,
comme [Panoptic](https://github.col/CERES-Sorbonne/panoptic).
Il prend en entrée les formats suivants:
- `".mov"`
- `".avi"`
- `".mp4"`
- `".flv"`
- `".wmv"`
- `".webm"`
- `".mkv"`
- `".svf"`
## Installation
### PyPi
Pellipop est disponible sur PyPi, vous pouvez l'installer avec pip à l'aide de la commande suivante:
```bash
pip install pellipop
```
Vous pouvez ensuite vérifier que l'installation s'est bien passée en lançant la commande `pellipop --version`
Une fois installé, vous pouvez lancer l'interface graphique avec la commande `pellipop`.
### Exécutable
Des exécutables sont disponibles pour Windows, MacOS et Linux sur la page de [releases](https://github.com/CERES-Sorbonne/Pellipop/releases/latest).
Vous pouvez télécharger l'exécutable correspondant à votre système d'exploitation, et lancer l'interface graphique en double-cliquant dessus.
### Développement
Pour installer Pellipop en mode développement, vous pouvez cloner le dépôt git et installer les dépendances avec pip:
```bash
git clone https://github.com/CERES-Sorbonne/Pellipop.git.
cd Pellipop
pip install -e .
```
## Usage
### Interface graphique
Elle se lance avec `pellipop`, sans aucun argument, pour ouvrir l'interface graphique.
Alternativement, vous pouvez télécharger l'executable correspondant à votre système d'exploitation sur la page
de [releases](https://github.com/CERES-Sorbonne/Pellipop/releases/latest).
### Ligne de commande
La cli se lance avec `pellipop` dans un terminal, par défaut les vidéos sont cherchées dans le dossier où la commande
est lancée, et les images créées sont également stockées au même endroit. Les paramètres peuvent toutefois être changés:
- `--input` : pour spécifier le dossier d'entrée où chercher les vidéos (recursif)
- `--output` : pour spécifier l'endroit où stocker les images en sortie
- `--interval` : intervalle de temps (en secondes) à laquelle réaliser des captures d'écran
- `--i-frame-mode` : permet de supprimer les doublons d'images pour un même film en utilisant les images clés (
keyframes) de la vidéo
- `--keep-audio` : permet de garder les fichiers audio extraits des vidéos
- `--whisper-config` : pour préciser le chemin vers le fichier de configuration de l'API Whisper, au lieu du chemin par
défaut (`~\.whisperrc`)
- `--frames-only` : permet de ne pas extraire le texte des vidéos
- `--reduce` : permet de réduire le nom des fichiers de sortie à un certain nombre de caractères du nom original
- `--offset` : permet de décaler le début du nom des fichiers de sortie de n caractères
- `--parents-in-name` : permet d'ajouter le nom des dossiers parents dans le nom des fichiers de sortie, séparés par des _
- `-g` ou `--gui` : permet d'utiliser l'interface graphique
- `-v` ou `--version` : affiche la version de l'installation actuelle de Pellipop
> Note: Le temps de découpe de chaque vidéo dépend de la qualité de la vidéo découpée, de la fréquence de découpe, de la durée de la vidéo et de la puissance de l'ordinateur.
#### Exemple d'usage:
```bash
pellipop --input C:\Users\Utilisateur\Videos\Captures --output D:\Users\Bureau\Output --i-frame-mode
```
## License
Ce projet est sous licence MPL-2.0 - voir le fichier [LICENSE](https://github.com/CERES-Sorbonne/Pellipop/blob/master/LICENSE.txt) pour plus de détails.
Raw data
{
"_id": null,
"home_page": null,
"name": "pellipop",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "STT, frame, keyframes, panoptic, speech, speech-to-text, transcription, video",
"author": "EdouardBoute",
"author_email": "Marceau-h <pypi@marceau-h.fr>, Orion Ali\u00e9 <someonefefe@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/12/7c/da87ba431e60b647d2e6bced90f1339ba6f13f4fb7e055558bc4bde98150/pellipop-0.9.1.tar.gz",
"platform": null,
"description": "# Pellipop\n\n[](https://pypi.org/project/pellipop)\n[](https://pypi.org/project/pellipop)\n\nThis readme is also available in [English](https://github.com/CERES-Sorbonne/Pellipop/blob/master/readme_en.md)\n\n## Table des mati\u00e8res\n1. [Description](#description)\n2. [Installation](#installation)\n 1. [PyPi](#pypi)\n 2. [Ex\u00e9cutable](#ex\u00e9cutable)\n 3. [D\u00e9veloppement](#d\u00e9veloppement)\n3. [Usage](#usage)\n 1. [Interface graphique](#interface-graphique)\n 2. [Ligne de commande](#ligne-de-commande)\n4. [License](#license)\n\n\n## Description\nPellipop est un outil de d\u00e9coupe de vid\u00e9os en images fixes, avec extraction de texte et audio.\nIl permet de d\u00e9couper des vid\u00e9os en images fixes, en extrayant le texte et l'audio des vid\u00e9os.\nIl permet \u00e9galement d'obtenir un fichier csv contenant les informations des images extraites et facilitant l'exportation\ndes donn\u00e9es dans des logiciels de traitement de corpus d'image,\ncomme [Panoptic](https://github.col/CERES-Sorbonne/panoptic).\n\nIl prend en entr\u00e9e les formats suivants:\n\n- `\".mov\"`\n- `\".avi\"`\n- `\".mp4\"`\n- `\".flv\"`\n- `\".wmv\"`\n- `\".webm\"`\n- `\".mkv\"`\n- `\".svf\"`\n\n## Installation\n### PyPi\nPellipop est disponible sur PyPi, vous pouvez l'installer avec pip \u00e0 l'aide de la commande suivante:\n```bash\npip install pellipop\n```\nVous pouvez ensuite v\u00e9rifier que l'installation s'est bien pass\u00e9e en lan\u00e7ant la commande `pellipop --version`\nUne fois install\u00e9, vous pouvez lancer l'interface graphique avec la commande `pellipop`.\n\n### Ex\u00e9cutable\nDes ex\u00e9cutables sont disponibles pour Windows, MacOS et Linux sur la page de [releases](https://github.com/CERES-Sorbonne/Pellipop/releases/latest).\nVous pouvez t\u00e9l\u00e9charger l'ex\u00e9cutable correspondant \u00e0 votre syst\u00e8me d'exploitation, et lancer l'interface graphique en double-cliquant dessus.\n\n### D\u00e9veloppement\nPour installer Pellipop en mode d\u00e9veloppement, vous pouvez cloner le d\u00e9p\u00f4t git et installer les d\u00e9pendances avec pip:\n```bash\ngit clone https://github.com/CERES-Sorbonne/Pellipop.git.\ncd Pellipop\npip install -e .\n```\n\n\n## Usage\n### Interface graphique\nElle se lance avec `pellipop`, sans aucun argument, pour ouvrir l'interface graphique.\n\nAlternativement, vous pouvez t\u00e9l\u00e9charger l'executable correspondant \u00e0 votre syst\u00e8me d'exploitation sur la page\nde [releases](https://github.com/CERES-Sorbonne/Pellipop/releases/latest).\n\n### Ligne de commande\nLa cli se lance avec `pellipop` dans un terminal, par d\u00e9faut les vid\u00e9os sont cherch\u00e9es dans le dossier o\u00f9 la commande\nest lanc\u00e9e, et les images cr\u00e9\u00e9es sont \u00e9galement stock\u00e9es au m\u00eame endroit. Les param\u00e8tres peuvent toutefois \u00eatre chang\u00e9s:\n\n- `--input` : pour sp\u00e9cifier le dossier d'entr\u00e9e o\u00f9 chercher les vid\u00e9os (recursif)\n- `--output` : pour sp\u00e9cifier l'endroit o\u00f9 stocker les images en sortie\n\n- `--interval` : intervalle de temps (en secondes) \u00e0 laquelle r\u00e9aliser des captures d'\u00e9cran\n- `--i-frame-mode` : permet de supprimer les doublons d'images pour un m\u00eame film en utilisant les images cl\u00e9s (\n keyframes) de la vid\u00e9o\n\n- `--keep-audio` : permet de garder les fichiers audio extraits des vid\u00e9os\n- `--whisper-config` : pour pr\u00e9ciser le chemin vers le fichier de configuration de l'API Whisper, au lieu du chemin par\n d\u00e9faut (`~\\.whisperrc`)\n\n- `--frames-only` : permet de ne pas extraire le texte des vid\u00e9os\n- `--reduce` : permet de r\u00e9duire le nom des fichiers de sortie \u00e0 un certain nombre de caract\u00e8res du nom original\n- `--offset` : permet de d\u00e9caler le d\u00e9but du nom des fichiers de sortie de n caract\u00e8res\n- `--parents-in-name` : permet d'ajouter le nom des dossiers parents dans le nom des fichiers de sortie, s\u00e9par\u00e9s par des _\n\n- `-g` ou `--gui` : permet d'utiliser l'interface graphique\n- `-v` ou `--version` : affiche la version de l'installation actuelle de Pellipop\n\n> Note: Le temps de d\u00e9coupe de chaque vid\u00e9o d\u00e9pend de la qualit\u00e9 de la vid\u00e9o d\u00e9coup\u00e9e, de la fr\u00e9quence de d\u00e9coupe, de la dur\u00e9e de la vid\u00e9o et de la puissance de l'ordinateur.\n\n#### Exemple d'usage:\n```bash\npellipop --input C:\\Users\\Utilisateur\\Videos\\Captures --output D:\\Users\\Bureau\\Output --i-frame-mode\n```\n\n\n## License\nCe projet est sous licence MPL-2.0 - voir le fichier [LICENSE](https://github.com/CERES-Sorbonne/Pellipop/blob/master/LICENSE.txt) pour plus de d\u00e9tails.\n",
"bugtrack_url": null,
"license": null,
"summary": "A graphical and command-line tool to extract key frames from videos along with their retranscription. It uses the Whisper API to transcribe the audio. It also generates a CSV file with the extracted key frames and their corresponding text.",
"version": "0.9.1",
"project_urls": {
"Documentation": "https://github.com/CERES-Sorbonne/Pellipop#readme",
"Homepage": "https://github.com/CERES-Sorbonne/Pellipop",
"Issues": "https://github.com/CERES-Sorbonne/Pellipop/issues",
"Source": "https://github.com/CERES-Sorbonne/Pellipop"
},
"split_keywords": [
"stt",
" frame",
" keyframes",
" panoptic",
" speech",
" speech-to-text",
" transcription",
" video"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0cf5f5b0523fdc7ed6baf94bff90f03ebcca086d39fb77e743fd6e79d204781c",
"md5": "4e11db4e0247b59131238765cc4578b7",
"sha256": "c384e9aed833c6b2cde15ab8b94c229b1e607ddfd6eb26c9d7aa939fb54844bd"
},
"downloads": -1,
"filename": "pellipop-0.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4e11db4e0247b59131238765cc4578b7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 53862,
"upload_time": "2024-07-23T13:49:32",
"upload_time_iso_8601": "2024-07-23T13:49:32.401927Z",
"url": "https://files.pythonhosted.org/packages/0c/f5/f5b0523fdc7ed6baf94bff90f03ebcca086d39fb77e743fd6e79d204781c/pellipop-0.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "127cda87ba431e60b647d2e6bced90f1339ba6f13f4fb7e055558bc4bde98150",
"md5": "65fe75fcf947e15b460f6fe0c8730bd1",
"sha256": "205af791511ea04015e3cde92f99fb65aa2c3b1afad002c30b0bbf04bbbf7d05"
},
"downloads": -1,
"filename": "pellipop-0.9.1.tar.gz",
"has_sig": false,
"md5_digest": "65fe75fcf947e15b460f6fe0c8730bd1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 53629,
"upload_time": "2024-07-23T13:49:34",
"upload_time_iso_8601": "2024-07-23T13:49:34.146432Z",
"url": "https://files.pythonhosted.org/packages/12/7c/da87ba431e60b647d2e6bced90f1339ba6f13f4fb7e055558bc4bde98150/pellipop-0.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-23 13:49:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CERES-Sorbonne",
"github_project": "Pellipop#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pellipop"
}
