From da98491cc8c0bb23b56d1ed10f04e373a0faa4be Mon Sep 17 00:00:00 2001
From: Georgiy Eterevskiy <goshik_e@mail.ru>
Date: Tue, 20 May 2025 17:50:01 +0300
Subject: [PATCH] Add description for modules

---
 .gitignore                    |  5 ++++-
 perxis/__init__.py            | 13 +++++++++++++
 perxis/extensions/__init__.py |  8 ++++++++
 3 files changed, 25 insertions(+), 1 deletion(-)

diff --git a/.gitignore b/.gitignore
index c0f8b6d..9e961d5 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 e69de29..70418ef 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 e69de29..3eb5a3a 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
-- 
GitLab