diff --git a/.gitignore b/.gitignore index c0f8b6d7cf4a174b290036aa020267b9c3e8eec6..9e961d5f87b48dac69e5959cb775f9e3ea224821 100644 --- a/.gitignore +++ b/.gitignore @@ -129,4 +129,7 @@ venv.bak/ dmypy.json # Pyre type checker -.pyre/ \ No newline at end of file +.pyre/ + +# pydoc +public \ No newline at end of file diff --git a/perxis/__init__.py b/perxis/__init__.py index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..70418eff9a88bd1d1b0e4d855049e80f7c7af593 100644 --- a/perxis/__init__.py +++ b/perxis/__init__.py @@ -0,0 +1,13 @@ +""" +Библиотека `perxis-python` это результат кодогенерации proto файлов для системы Perxis. +Библиотека также содержит набор дополинтельных модулей, упрощающих разработку python приложений. + +## Список дополнительных модулей: + +- .auth - Модуль для аутентификации в gRPC с использованием OAuth2 и API-ключей +- .channel - Модуль для создания защищенного gRPC-соединения +- .collections.helpers - Набор вспомогательных функций для установки схем коллекций в Perxis +- .extensions - Расширения для системы Perxis +- .files.uploader - Модуль для загрузки файлов в систему Perxis +- .provider - Модуль для работы с данными и файлами в системе Perxis +""" \ No newline at end of file diff --git a/perxis/extensions/__init__.py b/perxis/extensions/__init__.py index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..3eb5a3a46d9f4e68440051dc0588fa26a944eebf 100644 --- a/perxis/extensions/__init__.py +++ b/perxis/extensions/__init__.py @@ -0,0 +1,8 @@ +""" +## Список дополнительных модулей: + +- .actions - Модуль содержит вспомогательные функции для работы с экшнами +- .bootstrap - Модуль содержит функцию bootstrap для упрощения запуска сервисов расширений +- .extension_service - Модуль содержит базовый класс сервисов расширений - ExtensionService +- .extension_setup - Модуль содержит класс ExtensionSetup. Он используется для управления всеми данными расширения +""" \ No newline at end of file