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()