m3-gar-client 1.6.1

UI клиент для сервера ГАР m3-rest-gar

Пакет m3-gar-client предоставляет панель для ввода адресов Российской Федерации с использованием ГАР (Государственного адресного реестра), готовую к использованию в проектах на базе платформы M3 компании БАРС Груп.

Возможности

• Работа с сервером ГАР m3-rest-gar.

• Встраивание в интерфейс веб-приложений на базе ExtJS.

• Поиск адресов в ГАР по мере ввода наименований адресных объектов (субъектов Федерации, населенных пунктов, улиц, зданий).

Системные требования

• Python 3.6+

• Django 2.2 - 4.0

• m3-core 2.2

• m3-ui 2.2

Подключение в варианте 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

• USE_IMPROVED_SORTING — Включает улучшенную сортировку результатов поиска адресных объектов.

  При значении True результаты сортируются по количеству совпадений запроса с частями адреса, совпадению первых букв, а затем по алфавиту. При значении False (по умолчанию) используется стандартная сортировка по уровню объекта и алфавиту.

• OAUTH2 — параметры OAuth2: необходиы если не указано использовать простой сервер

  • TOKEN_URL — URL для получения токена, должен использоваться HTTPS.

  • CLIENT_ID — id клиента - создается на стороне РЕСТ сервера

  • CLIENT_SECRET — Секретный ключ клиента - генерируется на стороне РЕСТ сервера

  • USERNAME — username пользователя для получения токена

  • PASSWORD — password пользователя для получения токена

Работа над пакетом

Подготовка среды разработки

Необходимый набор инструментов:

• tox — оркестрация окружений и запуск команд

• tox-uv — для управлениями окружениями в tox

Быстрый старт

1. Установите необходимые инструменты:

uv tool install tox --with tox-uv

2. Клонируйте репозиторий и перейдите в директорию проекта:

git clone ssh://[e-mail]:7999/m3/m3-gar-client.git
cd m3-gar-client

3. Запустите тесты и проверки:

tox

Проверка качества и форматирование кода

tox -e lint