Updated docs

This commit is contained in:
2025-03-18 16:32:54 +03:00
parent 990508eb32
commit 6b6a0202a4
3 changed files with 14 additions and 2 deletions

View File

@@ -44,8 +44,20 @@
.. autofunction:: kontur_focus.Focus.excerpt(path) .. autofunction:: kontur_focus.Focus.excerpt(path)
Пример вывода результат по отчету:
.. code-block:: python
{'success': True, 'filename': '<имя_файла>', 'path': '<полный_путь_файла>'}
.. autofunction:: kontur_focus.Focus.express_report(pdf, 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.founders_history()
.. autofunction:: kontur_focus.Focus.foreign_representatives() .. autofunction:: kontur_focus.Focus.foreign_representatives()

View File

@@ -37,7 +37,7 @@ class Focus(Request):
:param path: Путь выгрузки файла. Если не указан, выгружается в текущий каталог. :param path: Путь выгрузки файла. Если не указан, выгружается в текущий каталог.
:type path: str, необязательный :type path: str, необязательный
:return: Результат и путьвыгрузки :return: Результат, имя файла и путь выгрузки
:rtype: str :rtype: str
""" """
response = self.get('/excerpt') response = self.get('/excerpt')

View File

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
setup( setup(
name="kontur_focus", name="kontur_focus",
version="0.2.2", version="0.2.3",
author="Ilya Sapunov", author="Ilya Sapunov",
author_email="sapunov@selectel.ru", author_email="sapunov@selectel.ru",
description="Библиотека-обертка для взаимодействия с REST API Контур.Фокус и Фокус.Комплаенс", description="Библиотека-обертка для взаимодействия с REST API Контур.Фокус и Фокус.Комплаенс",