https://github.com/firefly-cpp/thumbnails-readme
Create thumbnails
https://github.com/firefly-cpp/thumbnails-readme
Last synced: 6 days ago
JSON representation
Create thumbnails
- Host: GitHub
- URL: https://github.com/firefly-cpp/thumbnails-readme
- Owner: firefly-cpp
- License: bsd-3-clause
- Created: 2022-12-20T20:00:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-25T14:48:54.000Z (about 1 year ago)
- Last Synced: 2024-04-25T15:55:24.538Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 26.6 MB
- Stars: 2
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
thumbnails-readme
Create thumbnails for raster and vector images in parent and its subdirectories and append them to the README.md file
🚀 GitHub Action •
💡 How does it work? •
📦 Installation •
🔗 Additional dependencies •
📓 Example •
📂 Use Cases •
🔑 License •
📷 Thumbnails
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. The thumbnails are shown in the README file of that Git folder. 📁🌐📸
### 🔄 Multi-page PDFs are turned into .gif thumbnails
Current supported filetype extensions are: `.bmp`, `.gif`, `.ico`, `jpeg`, `.jpg`, `.png`, `.tga`, `.tiff`, `.webp`, `.pdf`, and `.svg`
## 🚀 GitHub Action
See the associated GitHub Action in the following repository: [thumbnails-readme-action](https://github.com/KukovecRok/thumbnails-readme-action).
## 💡 How does it work?
In the first step the program finds graphical material in your directories:
* ['fig1.pdf', 'fig2.pdf', 'fig3.pdf', 'fig4.pdf']
In the second step the program generates thumbnails for each material identified in folders.
In the third step the program appends thumbnails to the README file.
## 📦 Installation
To install `thumbnails-readme` with pip, use:
```sh
pip install thumbnails-readme
```
To install `thumbnails-readme` directly from the source code, use:
```sh
$ 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:
```sh
$ apk add py3-thumbnails-readme
```
To install `thumbnails-readme` on Arch Linux, use an [AUR helper](https://wiki.archlinux.org/title/AUR_helpers):
```sh
$ 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's users can install poppler-utils from the main repositories.
## 📓 Examples
### Examples of Usage
```python
# 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
``` python
# 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.crawl(path, path_to_readme, path_to_thumbnails_folder, MAX_SIZE, pdf_quality, skiplist, poppler_path)
```
## 📂 Use Cases
- [https://github.com/firefly-cpp/figures](https://github.com/firefly-cpp/figures)
- [https://github.com/firefly-cpp/posters](https://github.com/firefly-cpp/posters)
## 🔑 License
This package is distributed under the BSD-3-Clause license. This license can be found online at .
## 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!
## 📷 Thumbnails
[](tests/example-long.pdf)
[](tests/example-pdf.pdf)
[](tests/example-svg.svg)