Create thumbnails from Git folders
Project description
thumbnails-readme --- Create thumbnails
Description
The "thumbnails-readme" package is a simple library devoted to automatically generating thumbnails from a directory. It is explicitly designed to create thumbnails from Git folders and show thumbnails in the README file of that Git folder.
GitHub action
See also the associated GitHub action in the following repository: thumbnails-readme-action.
How it works?
First step: program finds graphical material in your directories
- ['fig1.pdf', 'fig2.pdf', 'fig3.pdf', 'fig4.pdf']
Second step: program generates thumbnails for each material identified in folders
Third step: program appends thumbnails into README
![Thumbnail](/image_thumbnails/PDFpismenka-interval_thumb.png)
Installation
Install thumbnails-readme with pip:
pip install thumbnails-readme
In case you want to install directly from the source code, use:
$ git clone https://github.com/firefly-cpp/thumbnails-readme.git
$ cd thumbnails-readme
$ poetry build
$ python setup.py install
To install thumbnails-readme on Alpine Linux, please use:
$ apk add py3-thumbnails-readme
To install thumbnails-readme on Arch Linux, please use an AUR helper:
$ yay -Syyu python-thumbnails-readme
Additional dependencies
Windows
Windows users have to download poppler for Windows. Add poppler path in your Python file (see the main example).
poppler_path = path/to/your/poppler/bin/
for example: poppler_path = C:/Program Files/poppler-0.68.0/bin
Linux
Linux users can install poppler-utils from the main repositories.
Example
# Maximum thumbnail size - lower the number, smaller the thumbnail
MAX_SIZE = (128, 128)
# PDF quality, lower the number, lower the quality
pdf_quality = 15
# Skiplist - which directories to ignore
skiplist = (
".git",
)
# Path to your directory
path = os.getcwd()
path = os.path.dirname(path)
# Path to the folder, you want new thumbnails to be placed in
path_to_thumbnails_folder = Path(path + "/image_thumbnails")
# Path to README.md file to be written to
path_to_readme = Path(path + "/README.md")
Run the script
# Prepare thumbnails folder (check if exists, delete old thumbnails and create new ones)
thumbnails_readme.prepare_thumbnails_folder(path_to_thumbnails_folder)
# Prepare README.md file (check if exists, delete last modifications and place newly generated ones)
thumbnails_readme.prepare_readme(path_to_readme)
# Generate thumbnails
thumbnails_readme.generate_thumbnails(path, path_to_thumbnails_folder, path_to_readme, MAX_SIZE, pdf_quality, skiplist)
License
This package is distributed under the MIT License. This license can be found online at http://www.opensource.org/licenses/MIT.
Disclaimer
This framework is provided as-is, and there are no guarantees that it fits your purposes or that it is bug-free. Use it at your own risk!
Project details
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
Built Distribution
Hashes for thumbnails_readme-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9eb0ff4a9eb514d7d9542202b5879ea59131114c95b9b073d88ee6332e786aa9 |
|
MD5 | 02fa866a3c43cf2b322137708e3c4164 |
|
BLAKE2b-256 | a7cc9050157fbfe075812389a45766f205c31ade06bcdc90bfe35e241df3558a |