Added license and code style badges
This commit is contained in:
parent
c2fb88ed65
commit
3f22340852
12
README.md
12
README.md
@ -1,9 +1,15 @@
|
||||
# TelegramPoster
|
||||
|
||||
<p align="center">
|
||||
<a href="https://git.end-play.xyz/profitroll/TelegramPoster/src/branch/master/LICENSE"><img alt="License: GPL" src="https://img.shields.io/badge/License-GPL-blue"></a>
|
||||
<a href="https://git.end-play.xyz/profitroll/TelegramPoster"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
|
||||
</p>
|
||||
> Шукаєш інструкцію українською? А вона [ось тут](https://git.end-play.xyz/profitroll/TelegramPoster/src/branch/master/README_uk.md) знаходиться)
|
||||
|
||||
This bot is used for one and only task - post pictures from my personal archive. Here's its source code so you can also host a bot and have fun with it. Just don't exepect it to be brilliant. It is not. But hey, you can always fork it ;)
|
||||
|
||||
## Installation
|
||||
|
||||
To make this bot run at first you need to have a Python interpreter and git. Google is your friend finding it. You can also ignore git and simply download source code, should also work fine. After that you're ready to go.
|
||||
|
||||
> In this README I assume that you're using default python in your
|
||||
@ -42,19 +48,23 @@ To make this bot run at first you need to have a Python interpreter and git. Goo
|
||||
Additionally there are `loop.sh` and `loop.bat` available if you want your bot to start again after being stopped or after using `/reboot` command.
|
||||
|
||||
## Command line arguments
|
||||
|
||||
Of course bot also has them. You can perform some actions with them.
|
||||
|
||||
* `--move-sent` - allows you to move all sent files from queue to sent directories
|
||||
* `--cleanup` - purge files in both `queue` and `sent` folders if they're sent. Requires `--confirm` argument
|
||||
* `--cleanup-index` - purge all sent entries from index. Requires `--confirm` argument
|
||||
* `--norun` - allows you to execute above arguments without triggering the bot start itself
|
||||
|
||||
Examples:
|
||||
|
||||
* `python3 ./main.py --move-sent --norun`
|
||||
* `python3 ./main.py --cleanup --confirm`
|
||||
|
||||
## Localization
|
||||
|
||||
Bot is capable of using custom locales. There are some that are pre-installed (English and Ukrainian), however you can add your own locales too.
|
||||
|
||||
All localization files are located in the `locale` folder, otherwise in folder specified in config file. Just copy locale file of your choice, name it in accordance to [IETF language tags](https://en.wikipedia.org/wiki/IETF_language_tag) (if you want your locale to be compatible with Telegram's locales) or define your own name. Save it as json and you're good to go. If you want to change default locale for messages, that cannot determine admin's locale - edit `"locale"` parameter in the `config.json`. If this locale is not available - `"locale_fallback"` will be used instead. If both are not available - error will be shown. For console output and logging locale you should edit `"locale_log"`.
|
||||
|
||||
We recommend to only make changes to your custom locale. Or at least always have your backup of for example `en.json` as your fallback.
|
||||
We recommend to only make changes to your custom locale. Or at least always have your backup of for example `en.json` as your fallback.
|
||||
|
||||
12
README_uk.md
12
README_uk.md
@ -1,7 +1,13 @@
|
||||
# TelegramPoster
|
||||
|
||||
<p align="center">
|
||||
<a href="https://git.end-play.xyz/profitroll/TelegramPoster/src/branch/master/LICENSE"><img alt="License: GPL" src="https://img.shields.io/badge/License-GPL-blue"></a>
|
||||
<a href="https://git.end-play.xyz/profitroll/TelegramPoster"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
|
||||
</p>
|
||||
Цей бот використовується для однієї-єдиної задачі - розміщувати фотографії з мого особистого архіву. Ось його код, тож Ви також можете захостити бота самостійно та розважитися з ним. Тільки не очікуйте, що він ідеальним. Не буде. Але гей, Ви завжди можете його доробити під себе ;)
|
||||
|
||||
## Установка
|
||||
|
||||
Для запуску цього бота спочатку потрібно мати інтерпретатор Python та встановлений git. Google — Ваш друг у пошуках. Ви також можете ігнорувати git і просто завантажити код, також має спрацювати добре. Після цього Ви готові до встановлення.
|
||||
|
||||
> У цьому README я вважаю, що Ви використовуєте python за замовчуванням у своїй
|
||||
@ -40,19 +46,23 @@
|
||||
Крім того, доступні `loop.sh` і `loop.bat`, якщо ви хочете, щоб ваш бот запускався знову після зупинки або після використання команди `/reboot`.
|
||||
|
||||
## Аргументи командного рядка
|
||||
|
||||
Звичайно, у бота вони також є. З ними можна виконувати деякі дії.
|
||||
|
||||
* `--move-sent` - дозволяє перемістити всі надіслані файли з черги до папки надісланих
|
||||
* `--cleanup` - очистити файли в папках `queue` і `sent`, якщо вони вже надіслані. Потрібен аргумент `--confirm`
|
||||
* `--cleanup-index` - видалити всі надіслані записи з індексу. Потрібен аргумент `--confirm`
|
||||
* `--norun` - дозволяє виконувати наведені вище аргументи, не запускаючи самого бота
|
||||
|
||||
Приклади:
|
||||
|
||||
* `python3 ./main.py --move-sent --norun`
|
||||
* `python3 ./main.py --cleanup --confirm`
|
||||
|
||||
## Локалізація
|
||||
|
||||
Бот може використовувати різні мови. Є деякі попередньо встановлені (Англійська та Українська), однак Ви можете додавати свої власні локалізації теж.
|
||||
|
||||
Всі файли локалізації знаходяться у папці `locale`, якщо в конфігураційному файлі не вказано іншу. Просто скопіюйте цікавлячий Вас файл, назвіть його відповідно до [тегів мови IETF](https://en.wikipedia.org/wiki/IETF_language_tag) (якщо Ви хочете, щоб переклад був сумісним з перекладами Telegram) або просто вкажіть свою власну назву. Збережіть свій переклад як json файл і все готово. Якщо ви хочете змінити мову за замовчуванням для повідомлень самого бота, які не можуть визначити мову адміністратора, відредагуйте параметр `"locale"` у `config.json`. Якщо ця мова недоступна, замість неї буде використано `"locale_fallback"`. Якщо обидві мови недоступні - буде показано помилку. Для зміни мови виведення консолі та логування вам слід відредагувати `"locale_log"`.
|
||||
|
||||
Ми рекомендуємо вносити будь-які зміни лише до вашої окремої мови. Або, принаймні, завжди мати резервну копію, наприклад, `en.json` як запасний варіант.
|
||||
Ми рекомендуємо вносити будь-які зміни лише до вашої окремої мови. Або, принаймні, завжди мати резервну копію, наприклад, `en.json` як запасний варіант.
|
||||
|
||||
Reference in New Issue
Block a user