Metadata-Version: 2.4
Name: m3-gar-client
Version: 0.2.0
Summary: UI клиент для сервера ГАР m3-rest-gar
Author-email: BARS Group <education_dev@bars.group>
Project-URL: Homepage, https://stash.bars-open.ru/projects/M3/repos/m3-gar-client/browse
Project-URL: Repository, https://stash.bars-open.ru/scm/m3/m3-gar-client.git
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Web Environment
Classifier: Natural Language :: Russian
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Framework :: Django :: 3.1
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.0
Classifier: Framework :: Django :: 4.1
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.2
Classifier: Framework :: Django :: 6.0
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: requests<3,>=2
Requires-Dist: Django<=6.1,>=3.1
Requires-Dist: m3-gar-constants>=1.0.4
Provides-Extra: oauth2
Requires-Dist: oauthlib<3.3,>=2; extra == "oauth2"
Requires-Dist: requests-oauthlib<1; extra == "oauth2"
Dynamic: license-file

Пакет ``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/>`_ 2.7
* `Django <http://djangoproject.com/>`_ 1.4 --- 1.11
* `m3-core <https://pypi.python.org/pypi/m3-core>`_ 2.2
* `m3-ui <https://pypi.python.org/pypi/m3-ui>`_ 2.2

Установка
---------

..

  pip install m3-gar-client


Настройки
---------
- ``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 пользователя для получения токена
