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

Updated docs

Browse Source
This commit is contained in:
slrover committed 2025-11-10 15:23:44 +03:00
1 parent 8a093175c4
commit 2af4797346
6 files changed
+13 -36
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/out/doctrees/environment.pickle
BIN
View File
Binary file not shown.
docs/out/doctrees/setup.doctree
BIN
View File
Binary file not shown.
docs/out/html/_sources/setup.rst.txt
+4 -13
View File
@@ -7,24 +7,15 @@
Установка через pip
-------------------
Выполните ``pip install kontur-focus --index-url https://__token__:<your_personal_token>@git.selectel.org/api/v4/projects/6350/packages/pypi/simple``
Выполните ``pip install --index-url https://git.slrover.ru/api/packages/public/pypi/simple/ kontur-focus``
Где `<your_personal_token>` - `персональный токен <https://git.selectel.org/help/user/profile/personal_access_tokens>`_ доступа Gitlab.
Использование requirements.txt
------------------------------
Перед использованием необходимо настроить Registry.
Добавьте в конец файла ``requirements.txt``::
Создайте файл `.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>`_.
--index-url https://git.slrover.ru/api/packages/public/pypi/simple/
kontur-focus
После выполните ``pip install -r requirements.txt``
docs/out/html/searchindex.js
+1 -1
View File
@@ -1 +1 @@
Search.setIndex({"alltitles":{"Contents:":[[2,null]],"Kontur Focus Library documentation":[[2,null]],"Open API specification":[[3,null]],"\u0418\u043d\u0438\u0446\u0438\u0430\u043b\u0438\u0437\u0430\u0446\u0438\u044f":[[0,"id3"],[1,"id3"]],"\u0418\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u043d\u0438\u0435 requirements.txt":[[4,"requirements-txt"]],"\u041e\u0441\u043d\u043e\u0432\u043d\u044b\u0435 \u043c\u0435\u0442\u043e\u0434\u044b":[[0,"id4"],[1,"id4"]],"\u041f\u043e\u0434\u0433\u043e\u0442\u043e\u0432\u043a\u0430":[[0,"id2"],[1,"id2"]],"\u0423\u0441\u0442\u0430\u043d\u043e\u0432\u043a\u0430":[[4,null]],"\u0423\u0441\u0442\u0430\u043d\u043e\u0432\u043a\u0430 \u0447\u0435\u0440\u0435\u0437 pip":[[4,"pip"]],"\u0424\u0438\u0437\u0438\u0447\u0435\u0441\u043a\u0438\u0435 \u043b\u0438\u0446\u0430":[[1,"id6"]],"\u0424\u043e\u043a\u0443\u0441":[[0,null]],"\u0424\u043e\u043a\u0443\u0441.\u041a\u043e\u043c\u043f\u043b\u0430\u0435\u043d\u0441":[[1,null]],"\u042e\u0440\u0438\u0434\u0438\u0447\u0435\u0441\u043a\u0438\u0435 \u043b\u0438\u0446\u0430":[[0,"id5"],[1,"id5"]]},"docnames":["focus","focus-compliance","index","open-api","setup"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1},"filenames":["focus.rst","focus-compliance.rst","index.rst","open-api.rst","setup.rst"],"indexentries":{"company_is_foreign_agent() (\u0432 \u043c\u043e\u0434\u0443\u043b\u0435 kontur_focus.focuscompliance)":[[1,"kontur_focus.FocusCompliance.company_is_foreign_agent",false]],"full_company_report() (\u0432 \u043c\u043e\u0434\u0443\u043b\u0435 kontur_focus.focuscompliance)":[[1,"kontur_focus.FocusCompliance.full_company_report",false]],"full_individual_report() (\u0432 \u043c\u043e\u0434\u0443\u043b\u0435 kontur_focus.focuscompliance)":[[1,"kontur_focus.FocusCompliance.full_individual_report",false]],"full_legal_entity_sanctions_profile() (\u0432 \u043c\u043e\u0434\u0443\u043b\u0435 kontur_focus.focuscompliance)":[[1,"kontur_focus.FocusCompliance.full_legal_entity_sanctions_profile",false]],"legal_entity_profile_report() (\u0432 \u043c\u043e\u0434\u0443\u043b\u0435 kontur_focus.focuscompliance)":[[1,"kontur_focus.FocusCompliance.legal_entity_profile_report",false]],"person_is_foreign_agent() (\u0432 \u043c\u043e\u0434\u0443\u043b\u0435 kontur_focus.focuscompliance)":[[1,"kontur_focus.FocusCompliance.person_is_foreign_agent",false]],"search_global_company_profiles_id() (\u0432 \u043c\u043e\u0434\u0443\u043b\u0435 kontur_focus.focuscompliance)":[[1,"kontur_focus.FocusCompliance.search_global_company_profiles_id",false]]},"objects":{"":[[3,0,1,"get--test","/test"]],"kontur_focus.Focus":[[0,1,1,"","advanced_info"],[0,1,1,"","base_info"],[0,1,1,"","excerpt"],[0,1,1,"","express_report"],[0,1,1,"","foreign_representatives"],[0,1,1,"","founders_history"]],"kontur_focus.FocusCompliance":[[1,1,1,"","company_is_foreign_agent"],[1,1,1,"","full_company_report"],[1,1,1,"","full_individual_report"],[1,1,1,"","full_legal_entity_sanctions_profile"],[1,1,1,"","legal_entity_profile_report"],[1,1,1,"","person_is_foreign_agent"],[1,1,1,"","search_global_company_profiles_id"]]},"objnames":{"0":["http","get","HTTP get"],"1":["py","function","Python \u0444\u0443\u043d\u043a\u0446\u0438\u044f"]},"objtypes":{"0":"http:get","1":"py:function"},"terms":{"115":1,"200":3,"6350":4,"__token__":4,"_description_":0,"_type_":0,"access":4,"advanced_info":0,"api":[0,1,2,4],"api3":0,"bankid":1,"banks":1,"base_info":0,"bool":[0,1],"codes":3,"companies":1,"company_is_foreign_agent":1,"company_name":1,"defaults":1,"dict":1,"env":[0,1],"excerpt":0,"express_report":0,"false":1,"fc":1,"filename":[0,1],"fio":1,"focus":[0,4],"focus_access_key":[0,1],"focus_base_url":0,"focus_compliance_access_key":1,"focus_compliance_base_url":1,"focuscompliance":1,"foreign_representatives":0,"founders_history":0,"from":[0,1],"full_company_report":1,"full_individual_report":1,"full_legal_entity_sanctions_profile":1,"fz":1,"get":[1,3],"git":4,"gitlab":4,"https":[0,1,4],"import":[0,1],"index":4,"inn":[0,1],"inn_string":[0,1],"install":4,"kontur":[0,1,4],"kontur_focus":[0,1],"kontur_url":[0,1],"kyc":1,"legal_entity_profile_report":1,"list":1,"model":1,"models":1,"none":1,"ogrn":[0,1],"ogrn_string":[0,1],"ok":3,"open":2,"optional":[0,1],"org":4,"packages":4,"passport":1,"password":4,"path":[0,1],"pdf":0,"person_is_foreign_agent":1,"personal":4,"pip":2,"profile_id_list":1,"profiles":1,"projects":4,"pypi":4,"pypirc":4,"r":4,"registry":4,"repository":4,"requirements":2,"rest":[0,1,2],"ru":[0,1],"search":1,"search_global_company_profiles_id":1,"selectel":4,"simple":4,"specification":2,"status":3,"str":[0,1],"success":[0,1],"test":3,"to":1,"token":4,"true":[0,1],"txt":2,"url":4,"username":4,"v4":4,"your":4,"your_access_key":[0,1Line truncated
Search.setIndex({"alltitles":{"Contents:":[[2,null]],"Kontur Focus Library documentation":[[2,null]],"Open API specification":[[3,null]],"\u0418\u043d\u0438\u0446\u0438\u0430\u043b\u0438\u0437\u0430\u0446\u0438\u044f":[[0,"id3"],[1,"id3"]],"\u0418\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u043d\u0438\u0435 requirements.txt":[[4,"requirements-txt"]],"\u041e\u0441\u043d\u043e\u0432\u043d\u044b\u0435 \u043c\u0435\u0442\u043e\u0434\u044b":[[0,"id4"],[1,"id4"]],"\u041f\u043e\u0434\u0433\u043e\u0442\u043e\u0432\u043a\u0430":[[0,"id2"],[1,"id2"]],"\u0423\u0441\u0442\u0430\u043d\u043e\u0432\u043a\u0430":[[4,null]],"\u0423\u0441\u0442\u0430\u043d\u043e\u0432\u043a\u0430 \u0447\u0435\u0440\u0435\u0437 pip":[[4,"pip"]],"\u0424\u0438\u0437\u0438\u0447\u0435\u0441\u043a\u0438\u0435 \u043b\u0438\u0446\u0430":[[1,"id6"]],"\u0424\u043e\u043a\u0443\u0441":[[0,null]],"\u0424\u043e\u043a\u0443\u0441.\u041a\u043e\u043c\u043f\u043b\u0430\u0435\u043d\u0441":[[1,null]],"\u042e\u0440\u0438\u0434\u0438\u0447\u0435\u0441\u043a\u0438\u0435 \u043b\u0438\u0446\u0430":[[0,"id5"],[1,"id5"]]},"docnames":["focus","focus-compliance","index","open-api","setup"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1},"filenames":["focus.rst","focus-compliance.rst","index.rst","open-api.rst","setup.rst"],"indexentries":{},"objects":{"":[[3,0,1,"get--test","/test"]],"kontur_focus.Focus":[[0,1,1,"","advanced_info"],[0,1,1,"","base_info"],[0,1,1,"","excerpt"],[0,1,1,"","express_report"],[0,1,1,"","foreign_representatives"],[0,1,1,"","founders_history"]],"kontur_focus.FocusCompliance":[[1,1,1,"","company_is_foreign_agent"],[1,1,1,"","full_company_report"],[1,1,1,"","full_individual_report"],[1,1,1,"","full_legal_entity_sanctions_profile"],[1,1,1,"","legal_entity_profile_report"],[1,1,1,"","person_is_foreign_agent"],[1,1,1,"","search_global_company_profiles_id"]]},"objnames":{"0":["http","get","HTTP get"],"1":["py","function","Python \u0444\u0443\u043d\u043a\u0446\u0438\u044f"]},"objtypes":{"0":"http:get","1":"py:function"},"terms":{"115":1,"200":3,"6350":[],"__token__":[],"_description_":0,"_type_":0,"access":[],"advanced_info":0,"api":[0,1,2,4],"api3":0,"bankid":1,"banks":1,"base_info":0,"bool":[0,1],"codes":3,"companies":1,"company_is_foreign_agent":1,"company_name":1,"defaults":1,"dict":1,"env":[0,1],"excerpt":0,"express_report":0,"false":1,"fc":1,"filename":[0,1],"fio":1,"focus":[0,4],"focus_access_key":[0,1],"focus_base_url":0,"focus_compliance_access_key":1,"focus_compliance_base_url":1,"focuscompliance":1,"foreign_representatives":0,"founders_history":0,"from":[0,1],"full_company_report":1,"full_individual_report":1,"full_legal_entity_sanctions_profile":1,"fz":1,"get":[1,3],"git":4,"gitlab":4,"https":[0,1,4],"import":[0,1],"index":4,"inn":[0,1],"inn_string":[0,1],"install":4,"kontur":[0,1,4],"kontur_focus":[0,1],"kontur_url":[0,1],"kyc":1,"legal_entity_profile_report":1,"list":1,"model":1,"models":1,"none":1,"ogrn":[0,1],"ogrn_string":[0,1],"ok":3,"open":2,"optional":[0,1],"org":[],"packages":4,"passport":1,"password":[],"path":[0,1],"pdf":0,"person_is_foreign_agent":1,"personal":[],"pip":2,"profile_id_list":1,"profiles":1,"projects":[],"public":4,"pypi":4,"pypirc":[],"r":4,"registry":4,"repository":[],"requirements":2,"rest":[0,1,2],"ru":[0,1,4],"search":1,"search_global_company_profiles_id":1,"selectel":[],"simple":4,"slrover":4,"specification":2,"status":3,"str":[0,1],"success":[0,1],"test":3,"to":1,"token":[],"true":[0,1],"txt":2,"url":4,"username":[],"v4":[],"your":[],"your_access_key":[0,1],"your_personal_token":[],"\u0430":[0,1],"\u0430\u0433\u0435\u043d\u0442":1,"\u0430\u0434\u0440\u0435\u0441":[0,1],"\u0431\u0430\u0437\u043e\u0432":0,"\u0431\u0438\u0431\u043b\u0438\u043e\u0442\u0435\u043a":2,"\u0431\u043e\u043b":[],"\u0431\u044b":1,"\u0432":[0,1,4],"\u0432\u0437\u0430\u0438\u043c\u043e\u0434\u0435\u0439\u0441\u0442\u0432":2,"\u0432\u043b\u0430\u0434\u0435\u043d":0,"\u0432\u043e\u0437\u0432\u0440\u0430\u0449\u0430":1,"\u0432\u0445\u043e\u0436\u0434\u0435\u043d":1,"\u0432\u044b\u0432\u043e\u0434":[0,1],"\u0432\u044b\u0433\u0440\u0443\u0436\u0430":0,"\u0432\u044b\u0433\u0440\u0443\u0437":0,"\u0432\u044b\u0433\u0440\u0443\u0437\u043a":0,"\u0432\u044b\u043f\u0438\u0441\u043a":0,"\u0432\u044b\u043f\u043e\u043b\u043d":4,"\u0433\u0434\u0435":[0,1],"\u0434\u0430\u043d":0,"\u0434\u0430\u0442":1,"\u0434\u043b\u044f":[2,4],"\u0434\u043e\u0431\u0430\u0432\u044c\u0442":[0,1,4],"\u0434\u043e\u0441\u0442\u0443\u043f":[0,1,4],"\u0435":1,"\u0435\u0433\u0440\u0438\u043f":0,"\u0435\u0433\u0440\u044e\u043b":0,"\u0435\u0441\u043b":0,"\u0437\u0430\u043f\u0440\u043e\u0441":1,"\u0438":[0,1,2],"\u0438\u0434\u0435\u043d\u0442\u0438\u0444\u0438\u043a\u0430\u0442\u043e\u0440":1,"\u0438Line truncated
docs/out/html/setup.html
+4 -9
View File
@@ -84,20 +84,15 @@
<p>Для установки необходимо иметь доступ в корпоративный <a class="reference external" href="https://git.selectel.org">Gitlab</a>, чтобы получить доступ к Registry PyPi.</p>
<section id="pip">
<h2>Установка через pip<a class="headerlink" href="#pip" title="Ссылка на этот заголовок"></a></h2>
<p>Выполните <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">kontur-focus</span> <span class="pre">--index-url</span> <span class="pre">https://__token__:&lt;your_personal_token&gt;&#64;git.selectel.org/api/v4/projects/6350/packages/pypi/simple</span></code></p>
<p>Где <cite>&lt;your_personal_token&gt;</cite> - <a class="reference external" href="https://git.selectel.org/help/user/profile/personal_access_tokens">персональный токен</a> доступа Gitlab.</p>
<p>Выполните <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">--index-url</span> <span class="pre">https://git.slrover.ru/api/packages/public/pypi/simple/</span> <span class="pre">kontur-focus</span></code></p>
</section>
<section id="requirements-txt">
<h2>Использование requirements.txt<a class="headerlink" href="#requirements-txt" title="Ссылка на этот заголовок"></a></h2>
<p>Перед использованием необходимо настроить Registry.</p>
<p>Создайте файл <cite>.pypirc</cite> в папке пользователя и добавьте параметры репозитория:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">[gitlab]</span>
<span class="go">repository = https://git.selectel.org/api/v4/projects/6350/packages/pypi</span>
<span class="go">username = __token__</span>
<span class="go">password = &lt;your personal access token&gt;</span>
<p>Добавьте в конец файла <code class="docutils literal notranslate"><span class="pre">requirements.txt</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">--</span><span class="n">index</span><span class="o">-</span><span class="n">url</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">git</span><span class="o">.</span><span class="n">slrover</span><span class="o">.</span><span class="n">ru</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="n">packages</span><span class="o">/</span><span class="n">public</span><span class="o">/</span><span class="n">pypi</span><span class="o">/</span><span class="n">simple</span><span class="o">/</span>
<span class="n">kontur</span><span class="o">-</span><span class="n">focus</span>
</pre></div>
</div>
<p>Более подробно <a class="reference external" href="https://git.selectel.org/help/user/packages/pypi_repository/index">тут</a>.</p>
<p>После выполните <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-r</span> <span class="pre">requirements.txt</span></code></p>
</section>
</section>