Generated docs

docs/out/html/_sources/focus-compliance.rst.txt

@@ -0,0 +1,51 @@
+===============
+Фокус.Комплаенс
+===============
+
+Подготовка
+----------
+
+Создайте файл `.env` или добавьте в существующий параметры:
+
+- `FOCUS_COMPLIANCE_BASE_URL=<kontur_url>`
+- `FOCUS_COMPLIANCE_ACCESS_KEY=<your_access_key>`
+
+Где `kontur_url` - адрес REST API Контур.Фокус. Например, `https://kyc.kontur.ru/api`.
+
+А `FOCUS_ACCESS_KEY` - секретный ключ доступа к REST API Контур.Фокус.
+
+Инициализация
+-------------
+
+.. code-block:: python
+
+    from kontur_focus import FocusCompliance
+
+    fc = FocusCompliance(inn='<inn_string>', ogrn='<ogrn_string>')
+
+Обязательный параметр - **ИНН**.
+
+
+Основные методы
+---------------
+
+Юридические лица
+----------------
+
+.. autofunction:: kontur_focus.FocusCompliance.company_is_foreign_agent()
+
+.. autofunction:: kontur_focus.FocusCompliance.search_global_company_profiles_id()
+
+.. autofunction:: kontur_focus.FocusCompliance.legal_entity_profile_report(profile_id_list, path)
+
+Пример вывода результат по отчету:
+
+.. code-block:: python
+
+    [{'success': True, 'filename': '<имя_файла>', 'path': '<полный_путь_файла>'}]
+
+
+Физические лица
+---------------
+
+.. autofunction:: kontur_focus.FocusCompliance.person_is_foreign_agent()

docs/out/html/_sources/focus.rst.txt

@@ -0,0 +1,63 @@
+=====
+Фокус
+=====
+
+Подготовка
+----------
+
+Создайте файл `.env` или добавьте в существующий параметры:
+
+- `FOCUS_BASE_URL=<kontur_url>`
+- `FOCUS_ACCESS_KEY=<your_access_key>`
+
+Где `kontur_url` - адрес REST API Контур.Фокус. Например, `https://focus-api.kontur.ru/api3`.
+
+А `FOCUS_ACCESS_KEY` - секретный ключ доступа к REST API Контур.Фокус.
+
+Инициализация
+-------------
+
+.. code-block:: python
+
+    from kontur_focus import Focus
+
+    focus = Focus(inn='<inn_string>', ogrn='<ogrn_string>')
+
+Обязательный параметр - **ИНН**.
+
+
+Основные методы
+---------------
+
+Пример использования методов:
+
+.. code-block:: python
+
+    focus.base_info()
+
+Юридические лица
+----------------
+
+.. autofunction:: kontur_focus.Focus.base_info()
+
+.. autofunction:: kontur_focus.Focus.advanced_info()
+
+.. autofunction:: kontur_focus.Focus.excerpt(path)
+
+Пример вывода результат по отчету:
+
+.. code-block:: python
+
+    {'success': True, 'filename': '<имя_файла>', 'path': '<полный_путь_файла>'}
+
+.. autofunction:: kontur_focus.Focus.express_report(pdf, path)
+
+Пример вывода результат по отчету:
+
+.. code-block:: python
+
+    {'success': True, 'filename': '<имя_файла>', 'path': '<полный_путь_файла>'}
+
+.. autofunction:: kontur_focus.Focus.founders_history()
+
+.. autofunction:: kontur_focus.Focus.foreign_representatives()

docs/out/html/_sources/index.rst.txt

@@ -0,0 +1,18 @@
+.. Kontur Focus Library documentation master file, created by
+   sphinx-quickstart on Mon Mar 10 17:54:03 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Kontur Focus Library documentation
+==================================
+
+Библиотека-обертка для взаимодействия с REST API Контур.Фокус и Фокус.Комплаенс.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   setup
+   focus
+   focus-compliance
+   open-api

docs/out/html/_sources/open-api.rst.txt

@@ -0,0 +1,5 @@
+======================
+Open API specification
+======================
+
+.. openapi:: focus.yml

docs/out/html/_sources/setup.rst.txt

@@ -0,0 +1,30 @@
+=========
+Установка
+=========
+
+Для установки необходимо иметь доступ в корпоративный `Gitlab <https://git.selectel.org>`_, чтобы получить доступ к Registry PyPi.
+
+Установка через pip
+-------------------
+
+Выполните ``pip install kontur-focus --index-url https://__token__:<your_personal_token>@git.selectel.org/api/v4/projects/6350/packages/pypi/simple``
+
+Где `<your_personal_token>` - `персональный токен <https://git.selectel.org/help/user/profile/personal_access_tokens>`_ доступа Gitlab.
+
+Использование requirements.txt
+------------------------------
+
+Перед использованием необходимо настроить Registry.
+
+Создайте файл `.pypirc` в папке пользователя и добавьте параметры репозитория:
+
+.. code-block:: console
+
+    [gitlab]
+    repository = https://git.selectel.org/api/v4/projects/6350/packages/pypi
+    username = __token__
+    password = <your personal access token>
+
+Более подробно `тут <https://git.selectel.org/help/user/packages/pypi_repository/index>`_.
+
+После выполните ``pip install -r requirements.txt``