Generation of file previews
Project description
Presentation
This module allows to generate jpeg and pdf preview for virtually any kind of files. It allows to generate preview for a given page. The context of creation of this module (as an example of use context) was for Tracim, a github project (https://github.com/Tracim/tracim) where users can put file on a repository in order to share it with other users. The only way to find a file was with his name. Hence it was decided to generate previews of the files in order to ease the location of one.
Format handled
JPEG |
TEXT |
HTML |
||
|---|---|---|---|---|
PNG |
☑ |
|||
JPEG |
☑ |
|||
BMP |
☑ |
|||
GIF |
☑ |
|||
☑ |
||||
Compressed files |
☑ |
☑ |
||
Office files (word, LibreOffice) |
☑ |
☑ |
||
Text |
☑ |
Installation
pip install preview_generator
Uses
Getting a preview
from PyPreviewGenerator.manager import *
manager = PreviewManager(path='/home/user/Pictures/')
path_to_file = manager.get_jpeg_preview(
file_path='/home/user/Pictures/myfile.gif',
height=100,
width=100,
)
print('Preview created at path : ', path_to_file)The preview manager
preview_manager = PreviewManager(cache_path)args :
cache_path : a String of the path to the directory where the cache file will be stored
returns :
a PreviewManager Object
The builders
Here is the way it is meant to be used
For Office types into PDF :
preview_manager = PreviewManager(cache_path)
preview = preview_manager.get_pdf_preview(file_path,page=page_id)-> Will create a preview from an office file into a pdf file
args :
file_path : the String of the path where is the file you want to get the preview
page : the page you want to get. If not mentioned all the pages will be returned
returns :
a FileIO stream of bytes of the pdf preview
For images(GIF, BMP, PNG, JPEG) into jpeg:
preview_manager = PreviewManager(cache_path)
preview = preview_manager.get_jpeg_preview(file_path,height=1024,width=526)-> Will create a preview from an image file into a jpeg file of size 1024 * 526
args :
file_path : the String of the path where is the file you want to get the preview
height : height of the preview in pixels
width : width of the preview in pixels. If not mentioned, width will be the same as height
returns :
a FileIO stream of byte*s of the jpeg preview
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for PyPreviewGenerator-0.1.10.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4233307e757079930516d1b4d15c531c0285025dbb408bd76a95f07d9d389633 |
|
| MD5 | 0779dc644df7d9637b91e6c02090edf2 |
|
| BLAKE2b-256 | 4ba9e8652ba43769cdc81a269681ab1d57e1c3beecd5f468881fddf64d20e7fc |
