From 03cbc64f481f7a778843743ebd32bd4d5fcf90ae Mon Sep 17 00:00:00 2001 From: kolo Date: Sat, 10 May 2025 21:56:34 +0300 Subject: [PATCH] translate readme --- README.md | 18 ++++++++------ README.ru.md | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++ pyproject.toml | 2 +- 3 files changed, 77 insertions(+), 9 deletions(-) create mode 100644 README.ru.md diff --git a/README.md b/README.md index b5f83a5..f768c00 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ # Argenta -### Библиотека для создания модульных CLI приложeний +### Library for creating modular CLI applications + +#### RU - [README.ru.md](https://github.com/koloideal/Argenta/blob/kolo/README.ru.md) ![preview](https://github.com/koloideal/Argenta/blob/kolo/imgs/mock_app_preview4.png?raw=True) --- -# Установка +# Installing ```bash pip install argenta ``` @@ -17,9 +19,9 @@ poetry add argenta --- -# Быстрый старт +# Quick start -Пример простейшего приложения +An example of a simple application ```python # routers.py from argenta.router import Router @@ -55,12 +57,12 @@ if __name__ == '__main__': --- -# Фичи в разработке +# Features in development -- Полноценная поддержка автокомплитера на Linux -- Возможность настройки захвата stdout при обработке хэндлером ввода +- Full support for autocompleter on Linux +- Ability to configure stdout capture when handling input by the handler -## Полная [документация](https://argenta-docs.vercel.app) | MIT 2025 kolo | made by [kolo](https://t.me/kolo_id) +## Full [docs](https://argenta-docs.vercel.app) | MIT 2025 kolo | made by [kolo](https://t.me/kolo_id) diff --git a/README.ru.md b/README.ru.md new file mode 100644 index 0000000..b5f83a5 --- /dev/null +++ b/README.ru.md @@ -0,0 +1,66 @@ +# Argenta + +### Библиотека для создания модульных CLI приложeний + +![preview](https://github.com/koloideal/Argenta/blob/kolo/imgs/mock_app_preview4.png?raw=True) + +--- + +# Установка +```bash +pip install argenta +``` +or +```bash +poetry add argenta +``` + +--- + +# Быстрый старт + +Пример простейшего приложения +```python +# routers.py +from argenta.router import Router +from argenta.command import Command +from argenta.response import Response + + +router = Router() + +@router.command(Command("hello")) +def handler(response: Response): + print("Hello, world!") +``` + +```python +# main.py +from argenta.app import App +from argenta.orchestrator import Orchestrator +from routers import router + +app: App = App() +orchestrator: Orchestrator = Orchestrator() + + +def main() -> None: + app.include_router(router) + orchestrator.start_polling(app) + + +if __name__ == '__main__': + main() +``` + +--- + +# Фичи в разработке + +- Полноценная поддержка автокомплитера на Linux +- Возможность настройки захвата stdout при обработке хэндлером ввода + +## Полная [документация](https://argenta-docs.vercel.app) | MIT 2025 kolo | made by [kolo](https://t.me/kolo_id) + + + diff --git a/pyproject.toml b/pyproject.toml index 07bba64..866b6aa 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "argenta" -version = "1.0.3" +version = "1.0.4" description = "Python library for building modular CLI applications" authors = [{ name = "kolo", email = "kolo.is.main@gmail.com" }] requires-python = ">=3.8"