mirror of
https://github.com/EDeev/converterbot.git
synced 2026-10-07 20:49:33 +03:00
Compare commits
No commits in common. "main" and "v1.0.0" have entirely different histories.
7 changed files with 32 additions and 26 deletions
8
.github/workflows/release.yml
vendored
8
.github/workflows/release.yml
vendored
|
|
@ -38,11 +38,17 @@ jobs:
|
|||
registry: ghcr.io
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
- uses: docker/login-action@v3
|
||||
with:
|
||||
registry: dcr.deev.su
|
||||
username: ${{ secrets.ZOT_USERNAME }}
|
||||
password: ${{ secrets.ZOT_PASSWORD }}
|
||||
- id: meta
|
||||
uses: docker/metadata-action@v5
|
||||
with:
|
||||
images: |
|
||||
ghcr.io/edeev/converterbot
|
||||
ghcr.io/edeev/my_converterbot
|
||||
dcr.deev.su/edeev/my_converterbot
|
||||
tags: |
|
||||
type=semver,pattern={{version}}
|
||||
type=semver,pattern={{major}}.{{minor}}
|
||||
|
|
|
|||
20
README.en.md
20
README.en.md
|
|
@ -1,11 +1,11 @@
|
|||
# Converter Bot · md2gost
|
||||
# My Converter Bot · md2gost
|
||||
|
||||
[Русский](https://github.com/EDeev/converterbot/blob/main/README.md) · **English**
|
||||
[Русский](https://github.com/EDeev/my_converterbot/blob/main/README.md) · **English**
|
||||
|
||||
[](https://github.com/EDeev/converterbot/actions/workflows/ci.yml)
|
||||
[](https://github.com/EDeev/my_converterbot/actions/workflows/ci.yml)
|
||||
[](https://pypi.org/project/md2gost/)
|
||||
[](https://pypi.org/project/md2gost/)
|
||||
[](https://github.com/EDeev/converterbot/blob/main/LICENSE)
|
||||
[](https://github.com/EDeev/my_converterbot/blob/main/LICENSE)
|
||||
|
||||
A Markdown to DOCX converter that follows GOST 7.32-2017 (the Russian standard for research and student
|
||||
reports), plus a Telegram bot for study routine: send a `.md` and get a report ready to submit, send a
|
||||
|
|
@ -15,7 +15,7 @@ own as the `md2gost` package on PyPI. The bot speaks Russian.
|
|||
**Status:** personal project, maintained · bot [@my_convbot](https://t.me/my_convbot) ·
|
||||
package [md2gost](https://pypi.org/project/md2gost/)
|
||||
|
||||
|
||||
|
||||
|
||||
**Stack:** Python 3.9+ · python-docx · aiogram 3 · Docker
|
||||
|
||||
|
|
@ -58,17 +58,17 @@ The Markdown parser is custom and line-based: nested tables and lists inside tab
|
|||
| `.md` | a GOST-formatted `.docx` (the same md2gost, with heading numbers) |
|
||||
| project `.zip` | a `.txt`: folder tree and contents of text files with line numbers, handy for an LLM or a report appendix |
|
||||
|
||||
Files up to 20 MB. Archives are checked before extraction: at most 10,000,000 files and 15 GB unpacked. Service
|
||||
Files up to 20 MB. Archives are checked before extraction: at most 5000 files and 200 MB unpacked. Service
|
||||
folders (`.git`, `node_modules`, `__pycache__`, `build`…) and binary files are skipped. Conversion runs in
|
||||
a separate thread, so the bot never freezes on big files.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/EDeev/converterbot.git && cd converterbot
|
||||
git clone https://github.com/EDeev/my_converterbot.git && cd my_converterbot
|
||||
cp .env.example .env # BOT_TOKEN from @BotFather
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
Prebuilt image: `docker pull ghcr.io/edeev/converterbot` or `docker pull git.deev.su/edeev/converterbot`.
|
||||
Prebuilt image: `docker pull ghcr.io/edeev/my_converterbot` or `docker pull dcr.deev.su/edeev/my_converterbot`.
|
||||
Without Docker: `pip install -r requirements.txt`, then `BOT_TOKEN=… python bot.py`.
|
||||
|
||||
`rep_to_txt.py` also works on its own: `python rep_to_txt.py path/to/project`.
|
||||
|
|
@ -81,11 +81,11 @@ ruff check --select E9,F,B . && pytest
|
|||
```
|
||||
|
||||
CI tests the package on Python 3.9, 3.12 and 3.13 and builds it. On `v*` tags the package is published to
|
||||
PyPI and the bot's Docker image to GitHub Packages and `git.deev.su`.
|
||||
PyPI and the bot's Docker image to GitHub Packages and `dcr.deev.su`.
|
||||
|
||||
## License
|
||||
|
||||
MIT — see [LICENSE](https://github.com/EDeev/converterbot/blob/main/LICENSE).
|
||||
MIT — see [LICENSE](https://github.com/EDeev/my_converterbot/blob/main/LICENSE).
|
||||
|
||||
## Author
|
||||
|
||||
|
|
|
|||
14
README.md
14
README.md
|
|
@ -1,11 +1,11 @@
|
|||
# Converter Bot · md2gost
|
||||
# My Converter Bot · md2gost
|
||||
|
||||
**Русский** · [English](README.en.md)
|
||||
|
||||
[](https://github.com/EDeev/converterbot/actions/workflows/ci.yml)
|
||||
[](https://github.com/EDeev/my_converterbot/actions/workflows/ci.yml)
|
||||
[](https://pypi.org/project/md2gost/)
|
||||
[](https://pypi.org/project/md2gost/)
|
||||
[](LICENSE)
|
||||
[](LICENSE)
|
||||
|
||||
Конвертер Markdown в DOCX по ГОСТ 7.32-2017 и Telegram-бот для учебной рутины: присылаешь `.md` —
|
||||
получаешь отчёт, готовый к сдаче, присылаешь `.zip` с проектом — получаешь `.txt` с деревом папок и
|
||||
|
|
@ -57,17 +57,17 @@ MarkdownToDocxConverter(settings).convert("report.md", "report.docx")
|
|||
| `.md` | `.docx` по ГОСТ (тот же md2gost с нумерацией заголовков) |
|
||||
| `.zip` с проектом | `.txt`: дерево папок и содержимое текстовых файлов с номерами строк — удобно отдать в LLM или приложить к отчёту |
|
||||
|
||||
Файлы — до 20 МБ. Архив проверяется до распаковки: не больше 10 000 000 файлов и 15 ГБ в распакованном виде.
|
||||
Файлы — до 20 МБ. Архив проверяется до распаковки: не больше 5000 файлов и 200 МБ в распакованном виде.
|
||||
Служебные папки (`.git`, `node_modules`, `__pycache__`, `build`…) и бинарные файлы пропускаются.
|
||||
Конвертация идёт в отдельном потоке, поэтому бот не замирает на больших файлах.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/EDeev/converterbot.git && cd converterbot
|
||||
git clone https://github.com/EDeev/my_converterbot.git && cd my_converterbot
|
||||
cp .env.example .env # BOT_TOKEN от @BotFather
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
Готовый образ: `docker pull ghcr.io/edeev/converterbot` или `docker pull git.deev.su/edeev/converterbot`.
|
||||
Готовый образ: `docker pull ghcr.io/edeev/my_converterbot` или `docker pull dcr.deev.su/edeev/my_converterbot`.
|
||||
Без Docker: `pip install -r requirements.txt`, затем `BOT_TOKEN=… python bot.py`.
|
||||
|
||||
`rep_to_txt.py` работает и сам по себе: `python rep_to_txt.py путь/к/проекту`.
|
||||
|
|
@ -90,7 +90,7 @@ ruff check --select E9,F,B . && pytest
|
|||
```
|
||||
|
||||
CI проверяет пакет на Python 3.9, 3.12 и 3.13 и собирает его. По тегу `v*` пакет публикуется на PyPI, а
|
||||
Docker-образ бота — в GitHub Packages и `git.deev.su`.
|
||||
Docker-образ бота — в GitHub Packages и `dcr.deev.su`.
|
||||
|
||||
## Лицензия
|
||||
|
||||
|
|
|
|||
8
bot.py
8
bot.py
|
|
@ -20,8 +20,8 @@ from rep_to_txt import generate_complete_project_structure
|
|||
BOT_TOKEN = os.getenv("BOT_TOKEN", "XXXXXXXXXXXXXXXXXXXXXXXX") # @my_convbot
|
||||
|
||||
MAX_FILE_SIZE = 20 * 1024 * 1024 # больше Telegram-боту не скачать
|
||||
MAX_UNPACKED_SIZE = 15 * 1024 ** 3 # защита от zip-бомбы: 15 ГБ в распакованном виде
|
||||
MAX_FILES_IN_ARCHIVE = 10_000_000
|
||||
MAX_UNPACKED_SIZE = 200 * 1024 * 1024 # защита от zip-бомбы
|
||||
MAX_FILES_IN_ARCHIVE = 5000
|
||||
|
||||
# Инициализация бота
|
||||
bot = Bot(token=BOT_TOKEN, default=DefaultBotProperties(parse_mode=ParseMode.HTML))
|
||||
|
|
@ -139,9 +139,9 @@ def check_archive(zip_ref: zipfile.ZipFile) -> None:
|
|||
"""Архив на 20 МБ может распаковаться в гигабайты и забить диск — проверяем до распаковки"""
|
||||
infos = zip_ref.infolist()
|
||||
if len(infos) > MAX_FILES_IN_ARCHIVE:
|
||||
raise ArchiveTooLarge(f"В архиве больше {MAX_FILES_IN_ARCHIVE:,} файлов".replace(",", " "))
|
||||
raise ArchiveTooLarge(f"В архиве больше {MAX_FILES_IN_ARCHIVE} файлов")
|
||||
if sum(info.file_size for info in infos) > MAX_UNPACKED_SIZE:
|
||||
raise ArchiveTooLarge(f"Распакованный архив больше {MAX_UNPACKED_SIZE / 1024 ** 3:g} ГБ")
|
||||
raise ArchiveTooLarge(f"Распакованный архив больше {MAX_UNPACKED_SIZE // 1024 // 1024} МБ")
|
||||
|
||||
|
||||
def analyze_archive(archive_path: str, temp_dir: str) -> str:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
services:
|
||||
bot:
|
||||
build: .
|
||||
image: ghcr.io/edeev/converterbot:latest
|
||||
image: ghcr.io/edeev/my_converterbot:latest
|
||||
env_file: .env
|
||||
restart: unless-stopped
|
||||
|
|
|
|||
|
|
@ -2,5 +2,5 @@
|
|||
|
||||
from .converter import DocumentSettings, MarkdownToDocxConverter
|
||||
|
||||
__version__ = "1.0.1"
|
||||
__version__ = "1.0.0"
|
||||
__all__ = ["DocumentSettings", "MarkdownToDocxConverter", "__version__"]
|
||||
|
|
|
|||
|
|
@ -23,8 +23,8 @@ classifiers = [
|
|||
]
|
||||
|
||||
[project.urls]
|
||||
Homepage = "https://github.com/EDeev/converterbot"
|
||||
Issues = "https://github.com/EDeev/converterbot/issues"
|
||||
Homepage = "https://github.com/EDeev/my_converterbot"
|
||||
Issues = "https://github.com/EDeev/my_converterbot/issues"
|
||||
Bot = "https://t.me/my_convbot"
|
||||
|
||||
[project.scripts]
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue