UI клиент для сервера ГАР m3-rest-gar
Project description
Пакет m3-gar-client предоставляет панель для ввода адресов Российской Федерации с использованием ГАР (Государственного адресного реестра), готовую к использованию в проектах на базе платформы M3 компании БАРС Груп.
Возможности
Работа с сервером ГАР m3-rest-gar.
Встраивание в интерфейс веб-приложений на базе ExtJS.
Поиск адресов в ГАР по мере ввода наименований адресных объектов (субъектов Федерации, населенных пунктов, улиц, зданий).
Системные требования
Подключение в варианте M3
Установка:
$ pip install m3-gar-client[m3]
Настройка:
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
Установка:
$ pip install m3-gar-client[rest]
Настройка:
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 пользователя для получения токена
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file m3-gar-client-1.2.0.tar.gz
.
File metadata
- Download URL: m3-gar-client-1.2.0.tar.gz
- Upload date:
- Size: 42.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/42.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.0.5 tqdm/4.66.2 importlib-metadata/6.8.0 keyring/24.2.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c06923ae27282de5d3d0ad5c3d041e4f60856f868b270afc49bb76e953528e2 |
|
MD5 | 307d02ef03a374fe041f494e1b12869a |
|
BLAKE2b-256 | 91af419a5fb34bd21b72fa222d89a37b0160171243069bb750685b7dca3efc61 |
File details
Details for the file m3_gar_client-1.2.0-py3-none-any.whl
.
File metadata
- Download URL: m3_gar_client-1.2.0-py3-none-any.whl
- Upload date:
- Size: 46.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/42.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.0.5 tqdm/4.66.2 importlib-metadata/6.8.0 keyring/24.2.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 61c10570a3369b163e3fa18dba09a935316418c0acfc6ab2c42fed0ff44c597f |
|
MD5 | d7da9a29ce3bb7d08e137fd6410b5eef |
|
BLAKE2b-256 | d68dacb0b9a6ca3d9c2e9b6af47984875e27c1d8ba6b0c41880d4a9f1e04ddee |