69 lines
1.5 KiB
Markdown
69 lines
1.5 KiB
Markdown
# Telegram Stickers Generator
|
|
|
|
## Description
|
|
|
|
A simple tool to convert any images and/or GIFs to the WebM format, enabling their use in creating animated sticker or emoji packs for Telegram.
|
|
|
|
## Features
|
|
|
|
- Converts images and GIFs to WebM.
|
|
- Compatible with Telegram's animated sticker/emoji requirements.
|
|
- Easy-to-use interface powered by Python.
|
|
|
|
## Requirements
|
|
|
|
- Python 3.13 or higher
|
|
- [FFmpeg](https://ffmpeg.org/) installed on your system
|
|
|
|
## Installation
|
|
|
|
### Using `uv` Tool
|
|
|
|
This project leverages the [uv tool](https://github.com/astral-sh/uv) for managing Python dependencies efficiently. Follow the steps below to set up the project:
|
|
|
|
1. **Install uv**
|
|
|
|
```bash
|
|
curl -LsSf https://github.com/astral-sh/uv/releases/download/0.5.9/uv-installer.sh | sh
|
|
```
|
|
|
|
2. **Clone the Repository**
|
|
|
|
```bash
|
|
git clone https://git.meowly.ru/Miwory/TelegramStickersGenerator.git
|
|
cd telegramstickersgenerator
|
|
```
|
|
|
|
3. **Sync Dependencies**
|
|
|
|
```bash
|
|
uv sync -p 3.13.1 --link-mode=copy
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Converting Images/GIFs to WebM
|
|
|
|
1. Place your images or GIFs in the desired directory.
|
|
2. Run the conversion script:
|
|
|
|
```bash
|
|
uv run main.py
|
|
```
|
|
|
|
### Linting and Pre-commit Checks
|
|
|
|
This project uses `pre-commit` and `ruff` for linting and formatting. You can run the linting tasks as follows:
|
|
|
|
```bash
|
|
poe lint
|
|
```
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! Please ensure pre-commit hooks pass before submitting a pull request.
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License. See `LICENSE` for details.
|