# Previewer
Command line tool to generate montages (image previews) from video clips or folders containing images.
# Install
Install `ffmpeg` if you want to generate previews for video clips.
```sh
$ sudo apt update
$ sudo apt install ffmpeg
```
Install the latest release of _previewer_ from [PyPI](https://pypi.org/project/previewer/)
```sh
$ pip3 install previewer
$ previewer --help
```
Or install _previewer_ from the sources
```sh
$ pip3 install poetry
$ pip3 install git+https://github.com/essembeh/previewer
$ previewer --help
```
# Usage
You can customize the generated image:
- change geometry (width, height, crop, fit or fill) of the thumbnails
- change the background color
- show or hide the a title
- adjust the space between thumbnails
- add a border, a shadow to thumbnails
## Example: generate a preview from a video clip
We can build a preview image of a video using:
```sh
$ previewer --crop 256 --shadow --title --background lightblue "samples/Rick Astley - Never Gonna Give You Up.mp4"
🎬 Generate montage from video samples/Rick Astley - Never Gonna Give You Up.mp4 using 36 thumbnails
🍺 Montage generated ./Rick Astley - Never Gonna Give You Up.jpg
```
## Example: generate a preview from a folder containing images
We can build a preview folder containing images like this:
```sh
$ previewer --columns 5 --polaroid --background b2967d "samples/Rick Astley - Never Gonna Give You Up"
📷 Generate montage from folder samples/Rick Astley - Never Gonna Give You Up/ containing 20 images
🍺 Montage generated ./Rick Astley - Never Gonna Give You Up.jpg
```
Raw data
{
"_id": null,
"home_page": "https://github.com/essembeh/previewer",
"name": "previewer",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "S\u00e9bastien MB",
"author_email": "seb@essembeh.org",
"download_url": "https://files.pythonhosted.org/packages/b8/07/24fdd26ca0d3c6d6be4cc2d8507bd3c11d8ca67763ce82688f085e5ba933/previewer-0.9.0.tar.gz",
"platform": null,
"description": "\n\n\n\n\n# Previewer\n\nCommand line tool to generate montages (image previews) from video clips or folders containing images.\n\n# Install\n\nInstall `ffmpeg` if you want to generate previews for video clips.\n\n```sh\n$ sudo apt update\n$ sudo apt install ffmpeg\n```\n\nInstall the latest release of _previewer_ from [PyPI](https://pypi.org/project/previewer/)\n\n```sh\n$ pip3 install previewer\n$ previewer --help\n```\n\nOr install _previewer_ from the sources\n\n```sh\n$ pip3 install poetry\n$ pip3 install git+https://github.com/essembeh/previewer\n$ previewer --help\n```\n\n# Usage\n\nYou can customize the generated image:\n\n- change geometry (width, height, crop, fit or fill) of the thumbnails\n- change the background color\n- show or hide the a title\n- adjust the space between thumbnails\n- add a border, a shadow to thumbnails\n\n## Example: generate a preview from a video clip\n\nWe can build a preview image of a video using:\n\n```sh\n$ previewer --crop 256 --shadow --title --background lightblue \"samples/Rick Astley - Never Gonna Give You Up.mp4\"\n\ud83c\udfac Generate montage from video samples/Rick Astley - Never Gonna Give You Up.mp4 using 36 thumbnails\n\ud83c\udf7a Montage generated ./Rick Astley - Never Gonna Give You Up.jpg\n```\n\n\n\n## Example: generate a preview from a folder containing images\n\nWe can build a preview folder containing images like this:\n\n\n\n```sh\n$ previewer --columns 5 --polaroid --background b2967d \"samples/Rick Astley - Never Gonna Give You Up\"\n\ud83d\udcf7 Generate montage from folder samples/Rick Astley - Never Gonna Give You Up/ containing 20 images\n\ud83c\udf7a Montage generated ./Rick Astley - Never Gonna Give You Up.jpg\n```\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Video or Folder preview generator",
"version": "0.9.0",
"project_urls": {
"Homepage": "https://github.com/essembeh/previewer"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "539d906ad168b9c5a3bc2dc94868b9941505928e7b351109ec434ced7d1e5728",
"md5": "428e7cf4079f485035e9387489730295",
"sha256": "eac04ac26cbc6510e6500de95ec7af70ca799d29dcea18eb7ca2c55a75c951e0"
},
"downloads": -1,
"filename": "previewer-0.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "428e7cf4079f485035e9387489730295",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 3830509,
"upload_time": "2023-08-22T12:10:21",
"upload_time_iso_8601": "2023-08-22T12:10:21.705852Z",
"url": "https://files.pythonhosted.org/packages/53/9d/906ad168b9c5a3bc2dc94868b9941505928e7b351109ec434ced7d1e5728/previewer-0.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b80724fdd26ca0d3c6d6be4cc2d8507bd3c11d8ca67763ce82688f085e5ba933",
"md5": "b5c8e60fd2d4cf275595f4299b2a867d",
"sha256": "098fe5e15efea4b36c966b2d2774b06efe68e0347ac9852f27b6df533ec08ec7"
},
"downloads": -1,
"filename": "previewer-0.9.0.tar.gz",
"has_sig": false,
"md5_digest": "b5c8e60fd2d4cf275595f4299b2a867d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 3817162,
"upload_time": "2023-08-22T12:10:23",
"upload_time_iso_8601": "2023-08-22T12:10:23.846872Z",
"url": "https://files.pythonhosted.org/packages/b8/07/24fdd26ca0d3c6d6be4cc2d8507bd3c11d8ca67763ce82688f085e5ba933/previewer-0.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-22 12:10:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "essembeh",
"github_project": "previewer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "previewer"
}
JSON
