This commit is contained in:
2025-10-15 16:17:52 +03:00
parent e68a6c48ac
commit 074ace7d54
36 changed files with 116 additions and 97 deletions
+1 -1
View File
@@ -9,7 +9,7 @@
project = "Argenta"
copyright = "2025, kolo"
author = "kolo"
root_doc = "root/index"
root_doc = "index"
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+7 -7
View File
@@ -37,18 +37,18 @@ Argenta нужна для создания приложений, которым
:hidden:
:caption: Контент:
quickstart
error_handling
dependency_injection
overriding_formatting
redirect_stdout
../api/index
root/quickstart
root/error_handling
root/dependency_injection
root/overriding_formatting
root/redirect_stdout
root/api/index
.. toctree::
:hidden:
:caption: Для разработчиков:
contributing
root/contributing
.. toctree::
:hidden:
+27 -26
View File
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 14:19+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,43 +19,40 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../index.rst:35
#: ../../index.rst:36
msgid "Контент:"
msgstr "Content:"
msgstr ""
#: ../../index.rst:45
#: ../../index.rst:47
msgid "Для разработчиков:"
msgstr "For developers:"
msgstr ""
#: ../../index.rst:51
#: ../../index.rst:53
msgid "GitHub"
msgstr ""
#: ../../index.rst:51
#: ../../index.rst:53
msgid "PyPI"
msgstr ""
#: ../../index.rst:51
#: ../../index.rst:53
msgid "Ссылки проекта:"
msgstr "Project Links"
msgstr ""
#: ../../index.rst:7
msgid "Argenta"
msgstr ""
#: ../../index.rst:9
#, fuzzy
msgid ""
"**Библиотека для построения модульных CLI-приложений с простым и приятным"
" API.**"
msgstr ""
"Python library for building modular CLI applications with simple and "
"agreeable API."
#: ../../index.rst:11
msgid ""
"У вас есть некая функциональность и вы хотите распространять её в виде "
"cli? Argenta поможет вам. Основная цель библиотеки дать возможность "
"CLI? Argenta поможет вам. Основная цель библиотеки дать возможность "
"разработчикам сфокусироваться на реализации своих идей, предоставляя для "
"этого удобные абстракциию."
msgstr ""
@@ -68,59 +65,63 @@ msgstr ""
msgid ""
"Argenta нужна для создания приложений, которым необходим свой скоуп, то "
"есть: при запуске приложения юзер входит в абстрагированный скоуп, в "
"котором у него есть доступ к созданной функциональности Один из основных "
"принципов библиотеки это цикличность, это значит, что после ввода юзером "
"команды он не выходит из скоупа, в этом основное отличие от таких "
"библиотек, как ``argparse``, ``click`` и ``typer``. Выход из скоупа "
"контролируется самим юзером."
"котором у него есть доступ к созданной функциональности."
msgstr ""
#: ../../index.rst:22
#: ../../index.rst:20
msgid ""
"Один из основных принципов библиотеки это цикличность, это значит, что "
"после ввода юзером команды он не выходит из скоупа, в этом основное "
"отличие от таких библиотек, как ``argparse``, ``click`` и ``typer``. "
"Выход из скоупа контролируется самим юзером."
msgstr ""
#: ../../index.rst:23
msgid "**Ключевые особенности:**"
msgstr ""
#: ../../index.rst:24
#: ../../index.rst:25
msgid ""
"**Обработчики**. Объекты представления приложения, непосредственные "
"обработчики введённых команд. Создание обработчиков максимально "
"декларативно"
msgstr ""
#: ../../index.rst:25
#: ../../index.rst:26
msgid ""
"**Маршрутизаторы**. Объекты маршрутизации, которые регистрируют "
"обработчиков, позволяя создавать кастомные настройки для групп "
"обработчиков, а также семантически их разделять."
msgstr ""
#: ../../index.rst:26
#: ../../index.rst:27
msgid ""
"**Приложение**. Объект управления жизненным циклом приложения, "
"подключения созданных маршрутизаторов, конфигурирования различных "
"вторичных утилит, таких как автокомплит, логирование и т.д."
msgstr ""
#: ../../index.rst:27
#: ../../index.rst:28
msgid ""
"**Оркестратор**. Объект *оркестрации*, который конфигурирует, запускает и"
" управляет всеми остальными компонентами программы."
msgstr ""
#: ../../index.rst:28
#: ../../index.rst:29
msgid ""
"**Внедрение зависимостей**. ``Argenta`` нативно поддерживает ``dishka`` и"
" предоставляет возможность инжектирования зависимостей в хэндлерах, "
"резолвя тайпхинты, подробнее_."
msgstr ""
#: ../../index.rst:32
#: ../../index.rst:33
msgid ""
"**Поддержка флагов**. Библиотека поддерживает определение флагов, "
"введённых вместе с командой, ``Argenta`` сама парсит и валидирует их, "
"отдавая понятные сущности."
msgstr ""
#: ../../index.rst:33
#: ../../index.rst:34
msgid ""
"**Поддержка аргументов**. Осуществленна поддержка аргументов командной "
"строки, позволяя пользователю передавать различные параметры при запуске "
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 11:06+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,7 +19,7 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../api/app/autocompleter.rst:4
#: ../../root/api/app/autocompleter.rst:4
msgid "Autocompleter"
msgstr ""
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 11:06+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,7 +19,7 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../api/app/dividing_lines.rst:4
#: ../../root/api/app/dividing_lines.rst:4
msgid "DividingLines"
msgstr ""
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 11:06+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,7 +19,7 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../api/app/index.rst:2
#: ../../root/api/app/index.rst:2
msgid "App"
msgstr ""
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 11:06+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,7 +19,7 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../api/command/flags.rst:4
#: ../../root/api/command/flags.rst:4
msgid "Flags"
msgstr ""
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 11:06+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,7 +19,7 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../api/command/index.rst:2
#: ../../root/api/command/index.rst:2
msgid "Command"
msgstr ""
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 11:06+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,11 +19,11 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../api/command/possible_values.rst:4
#: ../../root/api/command/possible_values.rst:4
msgid "PossibleValues"
msgstr ""
#: ../../api/command/possible_values.rst:6
#: ../../root/api/command/possible_values.rst:6
msgid "mda"
msgstr ""
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 11:06+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,11 +19,11 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../api/command/validation_status.rst:4
#: ../../root/api/command/validation_status.rst:4
msgid "ValidationStatus"
msgstr ""
#: ../../api/command/validation_status.rst:6
#: ../../root/api/command/validation_status.rst:6
msgid "case"
msgstr ""
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 13:40+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,10 +19,7 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../api/index.rst:2
#: ../../root/api/index.rst:2
msgid "Публичный API"
msgstr ""
#~ msgid "Public API"
#~ msgstr ""
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 11:06+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,11 +19,11 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../api/orchestrator/argparser.rst:4
#: ../../root/api/orchestrator/argparser.rst:4
msgid "Argparser"
msgstr ""
#: ../../api/orchestrator/argparser.rst:6
#: ../../root/api/orchestrator/argparser.rst:6
msgid "nu"
msgstr ""
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 11:06+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,11 +19,11 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../api/orchestrator/arguments.rst:4
#: ../../root/api/orchestrator/arguments.rst:4
msgid "Arguments"
msgstr ""
#: ../../api/orchestrator/arguments.rst:6
#: ../../root/api/orchestrator/arguments.rst:6
msgid "prikol"
msgstr ""
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 11:06+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,7 +19,7 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../api/orchestrator/index.rst:2
#: ../../root/api/orchestrator/index.rst:2
msgid "Orchestrator"
msgstr ""
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 11:06+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,7 +19,7 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../api/response.rst:4
#: ../../root/api/response.rst:4
msgid "Response"
msgstr ""
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 11:06+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,7 +19,7 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../api/router.rst:4
#: ../../root/api/router.rst:4
msgid "Router"
msgstr ""
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 13:40+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,20 +19,17 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../contributing.rst:2
#: ../../root/contributing.rst:4
msgid "Вклад в проект"
msgstr ""
#: ../../contributing.rst:4
#: ../../root/contributing.rst:6
msgid ""
"``argenta`` открытый проект и мы рады новым разработчикам в нашем "
"сообществе."
msgstr ""
#: ../../contributing.rst:7
#: ../../root/contributing.rst:9
msgid "Getting started"
msgstr ""
#~ msgid "Contributing"
#~ msgstr ""
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 11:06+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,7 +19,7 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../dependency_injection.rst:4
#: ../../root/dependency_injection.rst:4
msgid "Внедрение зависимостей"
msgstr ""
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 11:06+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,15 +19,15 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../error_handling.rst:2
#: ../../root/error_handling.rst:2
msgid "Обработка ошибок"
msgstr ""
#: ../../error_handling.rst:5
#: ../../root/error_handling.rst:5
msgid "Конфигурация"
msgstr ""
#: ../../error_handling.rst:7
#: ../../root/error_handling.rst:7
msgid "привет"
msgstr ""
@@ -0,0 +1,25 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2025, kolo
# This file is distributed under the same license as the Argenta package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
"Language-Team: en <LL@li.org>\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../root/overriding_formatting.rst:4
msgid "Переопределение форматирования"
msgstr ""
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 14:19+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,15 +19,15 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../quickstart.rst:4
#: ../../root/quickstart.rst:4
msgid "Быстрый старт"
msgstr ""
#: ../../quickstart.rst:6
#: ../../root/quickstart.rst:6
msgid "**Установка** ``Argenta``"
msgstr ""
#: ../../quickstart.rst:12
#: ../../root/quickstart.rst:12
msgid ""
"**Определение роутера и хэндлеров**, за регистрацию функции как "
"обработчика отвечает декоратор ``@router.command``, хэндлер всегда должен"
@@ -35,7 +35,7 @@ msgid ""
"<Response>`."
msgstr ""
#: ../../quickstart.rst:17
#: ../../root/quickstart.rst:17
msgid ""
"**Определение приложения и оркестратора**, для запуска приложения "
"необходимо вызвать ``.include_router()`` у созданного приложения и "
@@ -44,12 +44,11 @@ msgid ""
"приложение."
msgstr ""
#~ msgid "Quickstart"
#~ msgstr ""
#: ../../root/quickstart.rst:22
msgid "**Запуск приложения**, запускаем приложение как обычный процесс."
msgstr ""
#~ msgid "**Install Argenta**"
#~ msgstr ""
#~ msgid "**Установка**"
#~ msgstr ""
#: ../../root/quickstart.rst:25
msgid "Quickstart Example"
msgstr ""
@@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Argenta \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2025-10-15 13:40+0300\n"
"POT-Creation-Date: 2025-10-15 16:09+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
@@ -19,7 +19,7 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.17.0\n"
#: ../../redirect_stdout.rst:2
#: ../../root/redirect_stdout.rst:2
msgid "Перенаправление стандартного вывода"
msgstr ""
+3 -3
View File
@@ -9,17 +9,17 @@
pip install argenta
2. **Определение роутера и хэндлеров**, за регистрацию функции как обработчика отвечает декоратор ``@router.command``, хэндлер всегда должен принимать аргумент с типом ``Response``, подробнее в :ref:`разделе <Response>`.
2. **Определение роутера и хэндлеров**. За регистрацию функции как обработчика отвечает декоратор ``@router.command``, хэндлер всегда должен принимать аргумент с типом ``Response``, подробнее в :ref:`разделе <Response>`.
.. literalinclude:: ../code_snippets/quickstart_example_routers.py
:language: python
3. **Определение приложения и оркестратора**, для запуска приложения необходимо вызвать ``.include_router()`` у созданного приложения и передать ему раннее созданный роутер, после этого необходимо вызвать ``.start_polling()`` у созданного оркестратора и передать ему созданное приложение.
3. **Определение приложения и оркестратора**. Для запуска приложения необходимо вызвать ``.include_router()`` у созданного приложения и передать ему раннее созданный роутер, после этого необходимо вызвать ``.start_polling()`` у созданного оркестратора и передать ему созданное приложение.
.. literalinclude:: ../code_snippets/quickstart_example_main.py
:language: python
4. **Запуск приложения**, запускаем приложение как обычный процесс.
4. **Запуск приложения**. Запускаем приложение как обычный скрипт.
.. image:: https://github.com/koloideal/Argenta/blob/docs/create_docs/imgs/mock_app_preview6.png?raw=true