Обновленный текст

This commit is contained in:
2024-12-23 18:04:51 +03:00
parent 581530c6ec
commit e53da43eac
2 changed files with 64 additions and 10 deletions

View File

@ -1,14 +1,68 @@
# How to use script.ps1
# Telegram Stickers Generator Git
This script is designed to convert any images and/or gifs to webm extension so that they can be used to create animated sticker/emoji packs in Telegram.
## Description
## Setup
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.
1. Install ffmpeg and ffprobe on your system if they are not already installed.
2. Clone this repository and navigate to the directory containing script.ps1.
3. Create a directory named "input" and populate it with the images and/or gifs you want to convert.
4. Run the following command in your terminal: `& script.ps1`
## Features
## Output
- Converts images and GIFs to WebM.
- Compatible with Telegram's animated sticker/emoji requirements.
- Easy-to-use interface powered by Python.
The script will output the converted webm files to a directory named "output". The files will be named the same as the input files but with a .webm extension instead of their original extension.
## 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.

View File

@ -1,5 +1,5 @@
[project]
name = "telegramstickersgenerator-git"
name = "telegramstickersgenerator"
version = "1.0.0"
description = "A simple tool to convert any images and/or gifs to webm extension so that they can be used to create animated sticker/emoji packs in Telegram."
readme = "README.md"