feat: impl docs (#4)

The entire public api is covered with documentation in two languages - Russian and English.

the library now supports the latest three versions of python - 3.12, 3.13 and 3.14

minor design changes: now, when a Boolean flag is entered, its value is an empty string, not None.

tests have been adapted to the supported versions of python, readmi has been redesigned in two languages, German is no longer available.
This commit is contained in:
kolo
2025-12-04 21:55:19 +03:00
committed by GitHub
parent a2ac6a608f
commit ce7e24b924
210 changed files with 13770 additions and 1183 deletions
+10 -23
View File
@@ -1,29 +1,16 @@
from argenta import App, Orchestrator
from argenta.app import PredefinedMessages
from argenta.orchestrator.argparser import ArgParser, BooleanArgument
from argenta.app.dividing_line.models import DynamicDividingLine
from mock.mock_app.routers import work_router
from argenta import App, Orchestrator
from argenta.app import PredefinedMessages, DynamicDividingLine, AutoCompleter
from argenta.orchestrator import ArgParser
from argenta.orchestrator.argparser import BooleanArgument, ValueArgument
from dishka import Provider, provide, Scope # type: ignore
class temProvider(Provider):
@provide(scope=Scope.APP)
def get_apace(self) -> int:
return 1234
arg_parser: ArgParser = ArgParser(
processed_args=[
BooleanArgument(name="repeat", is_deprecated=True),
ValueArgument(name="required", is_required=True),
]
)
app: App = App(
dividing_line=DynamicDividingLine(),
autocompleter=AutoCompleter(),
dividing_line=DynamicDividingLine('^'),
)
orchestrator: Orchestrator = Orchestrator(arg_parser, custom_providers=[temProvider()])
argparser = ArgParser([BooleanArgument('some')])
orchestrator: Orchestrator = Orchestrator(argparser)
print(argparser.parsed_argspace.get_by_type(BooleanArgument))
def main():
app.include_router(work_router)
@@ -34,6 +21,6 @@ def main():
orchestrator.start_polling(app)
if __name__ == "__main__":
main()
orchestrator.start_polling(app)
+7 -22
View File
@@ -1,25 +1,10 @@
from argenta.command import Command, PredefinedFlags, Flags, Flag, PossibleValues
from argenta.response import Response
from argenta import Router
from argenta import Command, Response, Router
from argenta.command import Flag, Flags
work_router: Router = Router(title="Base points:", disable_redirect_stdout=True)
work_router: Router = Router(title="Work points:", disable_redirect_stdout=True)
flag = Flag("csdv", possible_values=PossibleValues.NEITHER)
@work_router.command(
Command(
"get",
description="Get Help",
aliases=["help", "Get_help"],
flags=Flags([PredefinedFlags.PORT, PredefinedFlags.HOST]),
)
)
@work_router.command(Command("hello", flags=Flags(Flag("test")), description="Hello, world!"))
def command_help(response: Response):
response.update_data({"data": [_ for _ in range(9999999)]})
@work_router.command("run")
def command_start_solving(response: Response):
print(response.get_data())
c = input("Enter your name: ")
print(f"Hello, {c}!")