public/kontur-focus-lib
1
0
Fork 0
Code Issues Pull Requests Packages Releases 12 Wiki Activity

Generated docs

Browse Source
This commit is contained in:
Ilya Sapunov
2025-07-22 18:28:16 +03:00
parent f229c309c4
commit 9a9ffda4ac
83 changed files with 8364 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

257
docs/out/html/focus.html Normal file
View File

@@ -0,0 +1,257 @@
<!DOCTYPE html>
<html class="writer-html5" lang="ru" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Фокус &mdash; документация Kontur Focus Library 0.1.0</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=6ff560e8"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/translations.js?v=cd1d70c9"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Алфавитный указатель" href="genindex.html" />
<link rel="search" title="Поиск" href="search.html" />
<link rel="next" title="Фокус.Комплаенс" href="focus-compliance.html" />
<link rel="prev" title="Установка" href="setup.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
Kontur Focus Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Поиск в документации" aria-label="Поиск в документации" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Меню навигации">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="setup.html">Установка</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Фокус</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#id2">Подготовка</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id3">Инициализация</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id4">Основные методы</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id5">Юридические лица</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.Focus.base_info"><code class="docutils literal notranslate"><span class="pre">base_info()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.Focus.advanced_info"><code class="docutils literal notranslate"><span class="pre">advanced_info()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.Focus.excerpt"><code class="docutils literal notranslate"><span class="pre">excerpt()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.Focus.express_report"><code class="docutils literal notranslate"><span class="pre">express_report()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.Focus.founders_history"><code class="docutils literal notranslate"><span class="pre">founders_history()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.Focus.foreign_representatives"><code class="docutils literal notranslate"><span class="pre">foreign_representatives()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="focus-compliance.html">Фокус.Комплаенс</a></li>
<li class="toctree-l1"><a class="reference internal" href="open-api.html">Open API specification</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Меню навигации для мобильных устройств" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Kontur Focus Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Навигация по страницам">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Фокус</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/focus.rst.txt" rel="nofollow"> Просмотреть исходный код страницы</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="id1">
<h1>Фокус<a class="headerlink" href="#id1" title="Ссылка на этот заголовок"></a></h1>
<section id="id2">
<h2>Подготовка<a class="headerlink" href="#id2" title="Ссылка на этот заголовок"></a></h2>
<p>Создайте файл <cite>.env</cite> или добавьте в существующий параметры:</p>
<ul class="simple">
<li><p><cite>FOCUS_BASE_URL=&lt;kontur_url&gt;</cite></p></li>
<li><p><cite>FOCUS_ACCESS_KEY=&lt;your_access_key&gt;</cite></p></li>
</ul>
<p>Где <cite>kontur_url</cite> - адрес REST API Контур.Фокус. Например, <cite>https://focus-api.kontur.ru/api3</cite>.</p>
<p>А <cite>FOCUS_ACCESS_KEY</cite> - секретный ключ доступа к REST API Контур.Фокус.</p>
</section>
<section id="id3">
<h2>Инициализация<a class="headerlink" href="#id3" title="Ссылка на этот заголовок"></a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">kontur_focus</span><span class="w"> </span><span class="kn">import</span> <span class="n">Focus</span>
<span class="n">focus</span> <span class="o">=</span> <span class="n">Focus</span><span class="p">(</span><span class="n">inn</span><span class="o">=</span><span class="s1">&#39;&lt;inn_string&gt;&#39;</span><span class="p">,</span> <span class="n">ogrn</span><span class="o">=</span><span class="s1">&#39;&lt;ogrn_string&gt;&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p>Обязательный параметр - <strong>ИНН</strong>.</p>
</section>
<section id="id4">
<h2>Основные методы<a class="headerlink" href="#id4" title="Ссылка на этот заголовок"></a></h2>
<p>Пример использования методов:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">focus</span><span class="o">.</span><span class="n">base_info</span><span class="p">()</span>
</pre></div>
</div>
</section>
<section id="id5">
<h2>Юридические лица<a class="headerlink" href="#id5" title="Ссылка на этот заголовок"></a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="kontur_focus.Focus.base_info">
<span class="sig-name descname"><span class="pre">base_info</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#kontur_focus.Focus.base_info" title="Ссылка на это определение"></a></dt>
<dd><p>Выгрузка базовых реквизитов Российских юридических лиц и индивидуальных предпринимателей</p>
<dl class="field-list simple">
<dt class="field-odd">Результат<span class="colon">:</span></dt>
<dd class="field-odd"><p>Информация о ЮЛ</p>
</dd>
<dt class="field-even">Тип результата<span class="colon">:</span></dt>
<dd class="field-even"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="kontur_focus.Focus.advanced_info">
<span class="sig-name descname"><span class="pre">advanced_info</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#kontur_focus.Focus.advanced_info" title="Ссылка на это определение"></a></dt>
<dd><p>Расширенные сведения на основе ЕГРЮЛ/ЕГРИП</p>
<dl class="field-list simple">
<dt class="field-odd">Результат<span class="colon">:</span></dt>
<dd class="field-odd"><p>Информация о ЮЛ</p>
</dd>
<dt class="field-even">Тип результата<span class="colon">:</span></dt>
<dd class="field-even"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="kontur_focus.Focus.excerpt">
<span class="sig-name descname"><span class="pre">excerpt</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kontur_focus.Focus.excerpt" title="Ссылка на это определение"></a></dt>
<dd><p>Выписка из ЕГРЮЛ/ЕГРИП</p>
<dl class="field-list simple">
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>path</strong> (<em>str</em><em>, </em><em>необязательный</em>) – Путь выгрузки файла. Если не указан, выгружается в текущий каталог.</p>
</dd>
<dt class="field-even">Результат<span class="colon">:</span></dt>
<dd class="field-even"><p>Результат, имя файла и путь выгрузки</p>
</dd>
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<p>Пример вывода результат по отчету:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s1">&#39;success&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s1">&#39;filename&#39;</span><span class="p">:</span> <span class="s1">&#39;&lt;имя_файла&gt;&#39;</span><span class="p">,</span> <span class="s1">&#39;path&#39;</span><span class="p">:</span> <span class="s1">&#39;&lt;полный_путь_файла&gt;&#39;</span><span class="p">}</span>
</pre></div>
</div>
<dl class="py function">
<dt class="sig sig-object py" id="kontur_focus.Focus.express_report">
<span class="sig-name descname"><span class="pre">express_report</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pdf</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kontur_focus.Focus.express_report" title="Ссылка на это определение"></a></dt>
<dd><p>Экспресс-отчет по контрагенту</p>
<dl class="field-list simple">
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>pdf</strong> (<em>bool</em><em>, </em><em>optional</em>) – Выгрузить PDF файл, по-умолчанию True</p></li>
<li><p><strong>path</strong> (<em>str</em><em>, </em><em>optional</em>) – Путь выгрузки файла. Если не указан, выгружается в текущий каталог.</p></li>
</ul>
</dd>
<dt class="field-even">Результат<span class="colon">:</span></dt>
<dd class="field-even"><p>_description_</p>
</dd>
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
<dd class="field-odd"><p>_type_</p>
</dd>
</dl>
</dd></dl>
<p>Пример вывода результат по отчету:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s1">&#39;success&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s1">&#39;filename&#39;</span><span class="p">:</span> <span class="s1">&#39;&lt;имя_файла&gt;&#39;</span><span class="p">,</span> <span class="s1">&#39;path&#39;</span><span class="p">:</span> <span class="s1">&#39;&lt;полный_путь_файла&gt;&#39;</span><span class="p">}</span>
</pre></div>
</div>
<dl class="py function">
<dt class="sig sig-object py" id="kontur_focus.Focus.founders_history">
<span class="sig-name descname"><span class="pre">founders_history</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#kontur_focus.Focus.founders_history" title="Ссылка на это определение"></a></dt>
<dd><p>История владения организацией</p>
<dl class="field-list simple">
<dt class="field-odd">Результат<span class="colon">:</span></dt>
<dd class="field-odd"><p>Набор полей с информацией об изменениях</p>
</dd>
<dt class="field-even">Тип результата<span class="colon">:</span></dt>
<dd class="field-even"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="kontur_focus.Focus.foreign_representatives">
<span class="sig-name descname"><span class="pre">foreign_representatives</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#kontur_focus.Focus.foreign_representatives" title="Ссылка на это определение"></a></dt>
<dd><p>Иностранные представительства и филиалы</p>
<dl class="field-list simple">
<dt class="field-odd">Результат<span class="colon">:</span></dt>
<dd class="field-odd"><p>Набор данных о представительствах</p>
</dd>
<dt class="field-even">Тип результата<span class="colon">:</span></dt>
<dd class="field-even"><p>str</p>
</dd>
</dl>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Нижняя область">
<a href="setup.html" class="btn btn-neutral float-left" title="Установка" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Предыдущая</a>
<a href="focus-compliance.html" class="btn btn-neutral float-right" title="Фокус.Комплаенс" accesskey="n" rel="next">Следующая <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Авторские права 2025, Ilya Sapunov. </p>
</div>
Собрано при помощи <a href="https://www.sphinx-doc.org/">Sphinx</a> с использованием
<a href="https://github.com/readthedocs/sphinx_rtd_theme">темы,</a>
предоставленной <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>