diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 81ded37..1d3c617 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -47,8 +47,8 @@ jobs: uses: docker/metadata-action@v5 with: images: | - ghcr.io/edeev/my_converterbot - dcr.deev.su/edeev/my_converterbot + ghcr.io/edeev/converterbot + dcr.deev.su/edeev/converterbot tags: | type=semver,pattern={{version}} type=semver,pattern={{major}}.{{minor}} diff --git a/README.en.md b/README.en.md index e58832e..8d8a3b0 100644 --- a/README.en.md +++ b/README.en.md @@ -1,11 +1,11 @@ -# My Converter Bot · md2gost +# Converter Bot · md2gost -[Русский](https://github.com/EDeev/my_converterbot/blob/main/README.md) · **English** +[Русский](https://github.com/EDeev/converterbot/blob/main/README.md) · **English** -[![CI](https://github.com/EDeev/my_converterbot/actions/workflows/ci.yml/badge.svg)](https://github.com/EDeev/my_converterbot/actions/workflows/ci.yml) +[![CI](https://github.com/EDeev/converterbot/actions/workflows/ci.yml/badge.svg)](https://github.com/EDeev/converterbot/actions/workflows/ci.yml) [![PyPI](https://img.shields.io/pypi/v/md2gost)](https://pypi.org/project/md2gost/) [![Python](https://img.shields.io/pypi/pyversions/md2gost)](https://pypi.org/project/md2gost/) -[![License](https://img.shields.io/github/license/EDeev/my_converterbot)](https://github.com/EDeev/my_converterbot/blob/main/LICENSE) +[![License](https://img.shields.io/github/license/EDeev/converterbot)](https://github.com/EDeev/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/) -![Pages of a report built with md2gost](https://raw.githubusercontent.com/EDeev/my_converterbot/main/docs/demo.png) +![Pages of a report built with md2gost](https://raw.githubusercontent.com/EDeev/converterbot/main/docs/demo.png) **Stack:** Python 3.9+ · python-docx · aiogram 3 · Docker @@ -63,12 +63,12 @@ folders (`.git`, `node_modules`, `__pycache__`, `build`…) and binary files are a separate thread, so the bot never freezes on big files. ```bash -git clone https://github.com/EDeev/my_converterbot.git && cd my_converterbot +git clone https://github.com/EDeev/converterbot.git && cd converterbot cp .env.example .env # BOT_TOKEN from @BotFather docker compose up -d ``` -Prebuilt image: `docker pull ghcr.io/edeev/my_converterbot` or `docker pull dcr.deev.su/edeev/my_converterbot`. +Prebuilt image: `docker pull ghcr.io/edeev/converterbot` or `docker pull dcr.deev.su/edeev/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`. @@ -85,7 +85,7 @@ PyPI and the bot's Docker image to GitHub Packages and `dcr.deev.su`. ## License -MIT — see [LICENSE](https://github.com/EDeev/my_converterbot/blob/main/LICENSE). +MIT — see [LICENSE](https://github.com/EDeev/converterbot/blob/main/LICENSE). ## Author diff --git a/README.md b/README.md index e2e039c..5a34825 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# My Converter Bot · md2gost +# Converter Bot · md2gost **Русский** · [English](README.en.md) -[![CI](https://github.com/EDeev/my_converterbot/actions/workflows/ci.yml/badge.svg)](https://github.com/EDeev/my_converterbot/actions/workflows/ci.yml) +[![CI](https://github.com/EDeev/converterbot/actions/workflows/ci.yml/badge.svg)](https://github.com/EDeev/converterbot/actions/workflows/ci.yml) [![PyPI](https://img.shields.io/pypi/v/md2gost)](https://pypi.org/project/md2gost/) [![Python](https://img.shields.io/pypi/pyversions/md2gost)](https://pypi.org/project/md2gost/) -[![License](https://img.shields.io/github/license/EDeev/my_converterbot)](LICENSE) +[![License](https://img.shields.io/github/license/EDeev/converterbot)](LICENSE) Конвертер Markdown в DOCX по ГОСТ 7.32-2017 и Telegram-бот для учебной рутины: присылаешь `.md` — получаешь отчёт, готовый к сдаче, присылаешь `.zip` с проектом — получаешь `.txt` с деревом папок и @@ -62,12 +62,12 @@ MarkdownToDocxConverter(settings).convert("report.md", "report.docx") Конвертация идёт в отдельном потоке, поэтому бот не замирает на больших файлах. ```bash -git clone https://github.com/EDeev/my_converterbot.git && cd my_converterbot +git clone https://github.com/EDeev/converterbot.git && cd converterbot cp .env.example .env # BOT_TOKEN от @BotFather docker compose up -d ``` -Готовый образ: `docker pull ghcr.io/edeev/my_converterbot` или `docker pull dcr.deev.su/edeev/my_converterbot`. +Готовый образ: `docker pull ghcr.io/edeev/converterbot` или `docker pull dcr.deev.su/edeev/converterbot`. Без Docker: `pip install -r requirements.txt`, затем `BOT_TOKEN=… python bot.py`. `rep_to_txt.py` работает и сам по себе: `python rep_to_txt.py путь/к/проекту`. diff --git a/compose.yaml b/compose.yaml index e1a67f1..1e7a031 100644 --- a/compose.yaml +++ b/compose.yaml @@ -1,6 +1,6 @@ services: bot: build: . - image: ghcr.io/edeev/my_converterbot:latest + image: ghcr.io/edeev/converterbot:latest env_file: .env restart: unless-stopped diff --git a/md2gost/__init__.py b/md2gost/__init__.py index 9e21d00..3d59e16 100644 --- a/md2gost/__init__.py +++ b/md2gost/__init__.py @@ -2,5 +2,5 @@ from .converter import DocumentSettings, MarkdownToDocxConverter -__version__ = "1.0.0" +__version__ = "1.0.1" __all__ = ["DocumentSettings", "MarkdownToDocxConverter", "__version__"] diff --git a/pyproject.toml b/pyproject.toml index b9ec4f0..c7e702a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -23,8 +23,8 @@ classifiers = [ ] [project.urls] -Homepage = "https://github.com/EDeev/my_converterbot" -Issues = "https://github.com/EDeev/my_converterbot/issues" +Homepage = "https://github.com/EDeev/converterbot" +Issues = "https://github.com/EDeev/converterbot/issues" Bot = "https://t.me/my_convbot" [project.scripts]