Пакет ``m3-gar-client`` предоставляет панель для ввода адресов Российской Федерации с
использованием `ГАР <https://fias.nalog.ru/>`_ (Государственного адресного реестра),
готовую к использованию в проектах на базе платформы
`M3 <http://m3.bars-open.ru/>`_ компании `БАРС Груп <http://bars.group>`_.
Возможности
-----------
* Работа с сервером ГАР `m3-rest-gar <https://stash.bars-open.ru/projects/M3/repos/m3-rest-gar>`_.
* Встраивание в интерфейс веб-приложений на базе ExtJS.
* Поиск адресов в ГАР по мере ввода наименований адресных объектов (субъектов
Федерации, населенных пунктов, улиц, зданий).
Системные требования
--------------------
* `Python <http://www.python.org/>`_ 3.6+
* `Django <http://djangoproject.com/>`_ 2.2 - 4.0
* `m3-core <https://pypi.python.org/pypi/m3-core>`_ 2.2
* `m3-ui <https://pypi.python.org/pypi/m3-ui>`_ 2.2
Подключение в варианте M3
-------------------------
Установка:
.. code-block:: bash
$ pip install m3-gar-client[m3]
Настройка:
.. code-block:: python
INSTALLED_APPS += [
'testapp',
'rest_framework',
'm3_gar_client',
]
GAR_API_URL = 'http://gar.bars.group/gar/v1/'
GAR = dict(
BACKEND='m3_gar_client.backends.m3_rest_gar.proxy', # <---
URL=GAR_API_URL,
USE_CACHE=True,
USE_SIMPLE_SERVER=True,
)
Подключение в варианте REST
---------------------------
Установка:
.. code-block:: bash
$ pip install m3-gar-client[rest]
Настройка:
.. code-block:: python
INSTALLED_APPS += [
'testapp',
'rest_framework',
'm3_gar_client',
]
GAR_API_URL = 'http://gar.bars.group/gar/v1/'
GAR = dict(
BACKEND='m3_gar_client.backends.m3_rest_gar.proxy_rest', # <---
URL=GAR_API_URL,
USE_CACHE=True,
USE_SIMPLE_SERVER=True,
REST=dict(
AUTHENTICATION_CLASSES=[
'oidc_auth.authentication.JSONWebTokenAuthentication'
],
PERMISSION_CLASSES=[
'rest_framework.permissions.IsAuthenticated'
]
)
)
Настройки
---------
- ``URL`` --- URL API сервера ГАР.
- ``TIMEOUT`` --- timeout запроса к серверу ГАР в секундах.
- ``PAGE_LIMIT`` --- количество страниц запрашиваемых у m3-rest-gar, по умолчанию 1. При большом количестве можно заддосить ГАР
- ``USE_CACHE`` --- определяет необходимость кеширования HTTP-запросов
к серверу m3-rest-gar. Значение по умолчанию: ``False``
- ``CACHE_TIMEOUT`` --- определяет длительность кэширования (в секундах). Значение по умолчанию: 24 часа
- ``USE_SIMPLE_SERVER`` --- Использовать простой сервер, по умолчанию будет использоваться сервер OAUTH2
- ``OAUTH2`` --- параметры OAuth2: необходиы если не указано использовать простой сервер
- ``TOKEN_URL`` --- URL для получения токена, должен использоваться HTTPS.
- ``CLIENT_ID`` --- id клиента - создается на стороне РЕСТ сервера
- ``CLIENT_SECRET`` --- Секретный ключ клиента - генерируется на стороне РЕСТ сервера
- ``USERNAME`` --- username пользователя для получения токена
- ``PASSWORD`` --- password пользователя для получения токена
Raw data
{
"_id": null,
"home_page": "https://stash.bars-open.ru/projects/M3/repos/m3-gar-client",
"name": "m3-gar-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "BARS Group",
"author_email": "bars@bars-open.ru",
"download_url": "https://files.pythonhosted.org/packages/91/af/419a5fb34bd21b72fa222d89a37b0160171243069bb750685b7dca3efc61/m3-gar-client-1.2.0.tar.gz",
"platform": null,
"description": "\u041f\u0430\u043a\u0435\u0442 ``m3-gar-client`` \u043f\u0440\u0435\u0434\u043e\u0441\u0442\u0430\u0432\u043b\u044f\u0435\u0442 \u043f\u0430\u043d\u0435\u043b\u044c \u0434\u043b\u044f \u0432\u0432\u043e\u0434\u0430 \u0430\u0434\u0440\u0435\u0441\u043e\u0432 \u0420\u043e\u0441\u0441\u0438\u0439\u0441\u043a\u043e\u0439 \u0424\u0435\u0434\u0435\u0440\u0430\u0446\u0438\u0438 \u0441\n\u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u043d\u0438\u0435\u043c `\u0413\u0410\u0420 <https://fias.nalog.ru/>`_ (\u0413\u043e\u0441\u0443\u0434\u0430\u0440\u0441\u0442\u0432\u0435\u043d\u043d\u043e\u0433\u043e \u0430\u0434\u0440\u0435\u0441\u043d\u043e\u0433\u043e \u0440\u0435\u0435\u0441\u0442\u0440\u0430),\n\u0433\u043e\u0442\u043e\u0432\u0443\u044e \u043a \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u043d\u0438\u044e \u0432 \u043f\u0440\u043e\u0435\u043a\u0442\u0430\u0445 \u043d\u0430 \u0431\u0430\u0437\u0435 \u043f\u043b\u0430\u0442\u0444\u043e\u0440\u043c\u044b\n`M3 <http://m3.bars-open.ru/>`_ \u043a\u043e\u043c\u043f\u0430\u043d\u0438\u0438 `\u0411\u0410\u0420\u0421 \u0413\u0440\u0443\u043f <http://bars.group>`_.\n\n\u0412\u043e\u0437\u043c\u043e\u0436\u043d\u043e\u0441\u0442\u0438\n-----------\n\n* \u0420\u0430\u0431\u043e\u0442\u0430 \u0441 \u0441\u0435\u0440\u0432\u0435\u0440\u043e\u043c \u0413\u0410\u0420 `m3-rest-gar <https://stash.bars-open.ru/projects/M3/repos/m3-rest-gar>`_.\n* \u0412\u0441\u0442\u0440\u0430\u0438\u0432\u0430\u043d\u0438\u0435 \u0432 \u0438\u043d\u0442\u0435\u0440\u0444\u0435\u0439\u0441 \u0432\u0435\u0431-\u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0439 \u043d\u0430 \u0431\u0430\u0437\u0435 ExtJS.\n* \u041f\u043e\u0438\u0441\u043a \u0430\u0434\u0440\u0435\u0441\u043e\u0432 \u0432 \u0413\u0410\u0420 \u043f\u043e \u043c\u0435\u0440\u0435 \u0432\u0432\u043e\u0434\u0430 \u043d\u0430\u0438\u043c\u0435\u043d\u043e\u0432\u0430\u043d\u0438\u0439 \u0430\u0434\u0440\u0435\u0441\u043d\u044b\u0445 \u043e\u0431\u044a\u0435\u043a\u0442\u043e\u0432 (\u0441\u0443\u0431\u044a\u0435\u043a\u0442\u043e\u0432\n \u0424\u0435\u0434\u0435\u0440\u0430\u0446\u0438\u0438, \u043d\u0430\u0441\u0435\u043b\u0435\u043d\u043d\u044b\u0445 \u043f\u0443\u043d\u043a\u0442\u043e\u0432, \u0443\u043b\u0438\u0446, \u0437\u0434\u0430\u043d\u0438\u0439).\n\n\u0421\u0438\u0441\u0442\u0435\u043c\u043d\u044b\u0435 \u0442\u0440\u0435\u0431\u043e\u0432\u0430\u043d\u0438\u044f\n--------------------\n\n* `Python <http://www.python.org/>`_ 3.6+\n* `Django <http://djangoproject.com/>`_ 2.2 - 4.0\n* `m3-core <https://pypi.python.org/pypi/m3-core>`_ 2.2\n* `m3-ui <https://pypi.python.org/pypi/m3-ui>`_ 2.2\n\n\n\u041f\u043e\u0434\u043a\u043b\u044e\u0447\u0435\u043d\u0438\u0435 \u0432 \u0432\u0430\u0440\u0438\u0430\u043d\u0442\u0435 M3\n-------------------------\n\n\u0423\u0441\u0442\u0430\u043d\u043e\u0432\u043a\u0430:\n\n.. code-block:: bash\n\n $ pip install m3-gar-client[m3]\n\n\n\u041d\u0430\u0441\u0442\u0440\u043e\u0439\u043a\u0430:\n\n.. code-block:: python\n\n INSTALLED_APPS += [\n 'testapp',\n 'rest_framework',\n 'm3_gar_client',\n ]\n\n GAR_API_URL = 'http://gar.bars.group/gar/v1/'\n\n GAR = dict(\n BACKEND='m3_gar_client.backends.m3_rest_gar.proxy', # <---\n URL=GAR_API_URL,\n USE_CACHE=True,\n USE_SIMPLE_SERVER=True,\n )\n\n\n\u041f\u043e\u0434\u043a\u043b\u044e\u0447\u0435\u043d\u0438\u0435 \u0432 \u0432\u0430\u0440\u0438\u0430\u043d\u0442\u0435 REST\n---------------------------\n\n\u0423\u0441\u0442\u0430\u043d\u043e\u0432\u043a\u0430:\n\n.. code-block:: bash\n\n $ pip install m3-gar-client[rest]\n\n\n\u041d\u0430\u0441\u0442\u0440\u043e\u0439\u043a\u0430:\n\n.. code-block:: python\n\n INSTALLED_APPS += [\n 'testapp',\n 'rest_framework',\n 'm3_gar_client',\n ]\n\n GAR_API_URL = 'http://gar.bars.group/gar/v1/'\n\n GAR = dict(\n BACKEND='m3_gar_client.backends.m3_rest_gar.proxy_rest', # <---\n URL=GAR_API_URL,\n USE_CACHE=True,\n USE_SIMPLE_SERVER=True,\n REST=dict(\n AUTHENTICATION_CLASSES=[\n 'oidc_auth.authentication.JSONWebTokenAuthentication'\n ],\n PERMISSION_CLASSES=[\n 'rest_framework.permissions.IsAuthenticated'\n ]\n )\n )\n\n\n\u041d\u0430\u0441\u0442\u0440\u043e\u0439\u043a\u0438\n---------\n- ``URL`` --- URL API \u0441\u0435\u0440\u0432\u0435\u0440\u0430 \u0413\u0410\u0420.\n- ``TIMEOUT`` --- timeout \u0437\u0430\u043f\u0440\u043e\u0441\u0430 \u043a \u0441\u0435\u0440\u0432\u0435\u0440\u0443 \u0413\u0410\u0420 \u0432 \u0441\u0435\u043a\u0443\u043d\u0434\u0430\u0445.\n- ``PAGE_LIMIT`` --- \u043a\u043e\u043b\u0438\u0447\u0435\u0441\u0442\u0432\u043e \u0441\u0442\u0440\u0430\u043d\u0438\u0446 \u0437\u0430\u043f\u0440\u0430\u0448\u0438\u0432\u0430\u0435\u043c\u044b\u0445 \u0443 m3-rest-gar, \u043f\u043e \u0443\u043c\u043e\u043b\u0447\u0430\u043d\u0438\u044e 1. \u041f\u0440\u0438 \u0431\u043e\u043b\u044c\u0448\u043e\u043c \u043a\u043e\u043b\u0438\u0447\u0435\u0441\u0442\u0432\u0435 \u043c\u043e\u0436\u043d\u043e \u0437\u0430\u0434\u0434\u043e\u0441\u0438\u0442\u044c \u0413\u0410\u0420\n- ``USE_CACHE`` --- \u043e\u043f\u0440\u0435\u0434\u0435\u043b\u044f\u0435\u0442 \u043d\u0435\u043e\u0431\u0445\u043e\u0434\u0438\u043c\u043e\u0441\u0442\u044c \u043a\u0435\u0448\u0438\u0440\u043e\u0432\u0430\u043d\u0438\u044f HTTP-\u0437\u0430\u043f\u0440\u043e\u0441\u043e\u0432\n \u043a \u0441\u0435\u0440\u0432\u0435\u0440\u0443 m3-rest-gar. \u0417\u043d\u0430\u0447\u0435\u043d\u0438\u0435 \u043f\u043e \u0443\u043c\u043e\u043b\u0447\u0430\u043d\u0438\u044e: ``False``\n- ``CACHE_TIMEOUT`` --- \u043e\u043f\u0440\u0435\u0434\u0435\u043b\u044f\u0435\u0442 \u0434\u043b\u0438\u0442\u0435\u043b\u044c\u043d\u043e\u0441\u0442\u044c \u043a\u044d\u0448\u0438\u0440\u043e\u0432\u0430\u043d\u0438\u044f (\u0432 \u0441\u0435\u043a\u0443\u043d\u0434\u0430\u0445). \u0417\u043d\u0430\u0447\u0435\u043d\u0438\u0435 \u043f\u043e \u0443\u043c\u043e\u043b\u0447\u0430\u043d\u0438\u044e: 24 \u0447\u0430\u0441\u0430\n- ``USE_SIMPLE_SERVER`` --- \u0418\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u044c \u043f\u0440\u043e\u0441\u0442\u043e\u0439 \u0441\u0435\u0440\u0432\u0435\u0440, \u043f\u043e \u0443\u043c\u043e\u043b\u0447\u0430\u043d\u0438\u044e \u0431\u0443\u0434\u0435\u0442 \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u044c\u0441\u044f \u0441\u0435\u0440\u0432\u0435\u0440 OAUTH2\n- ``OAUTH2`` --- \u043f\u0430\u0440\u0430\u043c\u0435\u0442\u0440\u044b OAuth2: \u043d\u0435\u043e\u0431\u0445\u043e\u0434\u0438\u044b \u0435\u0441\u043b\u0438 \u043d\u0435 \u0443\u043a\u0430\u0437\u0430\u043d\u043e \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u044c \u043f\u0440\u043e\u0441\u0442\u043e\u0439 \u0441\u0435\u0440\u0432\u0435\u0440\n\n - ``TOKEN_URL`` --- URL \u0434\u043b\u044f \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u0438\u044f \u0442\u043e\u043a\u0435\u043d\u0430, \u0434\u043e\u043b\u0436\u0435\u043d \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u044c\u0441\u044f HTTPS.\n - ``CLIENT_ID`` --- id \u043a\u043b\u0438\u0435\u043d\u0442\u0430 - \u0441\u043e\u0437\u0434\u0430\u0435\u0442\u0441\u044f \u043d\u0430 \u0441\u0442\u043e\u0440\u043e\u043d\u0435 \u0420\u0415\u0421\u0422 \u0441\u0435\u0440\u0432\u0435\u0440\u0430\n - ``CLIENT_SECRET`` --- \u0421\u0435\u043a\u0440\u0435\u0442\u043d\u044b\u0439 \u043a\u043b\u044e\u0447 \u043a\u043b\u0438\u0435\u043d\u0442\u0430 - \u0433\u0435\u043d\u0435\u0440\u0438\u0440\u0443\u0435\u0442\u0441\u044f \u043d\u0430 \u0441\u0442\u043e\u0440\u043e\u043d\u0435 \u0420\u0415\u0421\u0422 \u0441\u0435\u0440\u0432\u0435\u0440\u0430\n - ``USERNAME`` --- username \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044f \u0434\u043b\u044f \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u0438\u044f \u0442\u043e\u043a\u0435\u043d\u0430\n - ``PASSWORD`` --- password \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044f \u0434\u043b\u044f \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u0438\u044f \u0442\u043e\u043a\u0435\u043d\u0430\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "UI \u043a\u043b\u0438\u0435\u043d\u0442 \u0434\u043b\u044f \u0441\u0435\u0440\u0432\u0435\u0440\u0430 \u0413\u0410\u0420 m3-rest-gar",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://stash.bars-open.ru/projects/M3/repos/m3-gar-client"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d68dacb0b9a6ca3d9c2e9b6af47984875e27c1d8ba6b0c41880d4a9f1e04ddee",
"md5": "d7da9a29ce3bb7d08e137fd6410b5eef",
"sha256": "61c10570a3369b163e3fa18dba09a935316418c0acfc6ab2c42fed0ff44c597f"
},
"downloads": -1,
"filename": "m3_gar_client-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d7da9a29ce3bb7d08e137fd6410b5eef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 46571,
"upload_time": "2024-04-08T12:22:23",
"upload_time_iso_8601": "2024-04-08T12:22:23.648990Z",
"url": "https://files.pythonhosted.org/packages/d6/8d/acb0b9a6ca3d9c2e9b6af47984875e27c1d8ba6b0c41880d4a9f1e04ddee/m3_gar_client-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "91af419a5fb34bd21b72fa222d89a37b0160171243069bb750685b7dca3efc61",
"md5": "307d02ef03a374fe041f494e1b12869a",
"sha256": "8c06923ae27282de5d3d0ad5c3d041e4f60856f868b270afc49bb76e953528e2"
},
"downloads": -1,
"filename": "m3-gar-client-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "307d02ef03a374fe041f494e1b12869a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 42719,
"upload_time": "2024-04-08T12:22:27",
"upload_time_iso_8601": "2024-04-08T12:22:27.919895Z",
"url": "https://files.pythonhosted.org/packages/91/af/419a5fb34bd21b72fa222d89a37b0160171243069bb750685b7dca3efc61/m3-gar-client-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-08 12:22:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "m3-gar-client"
}
JSON