ruopenrefs

Общероссийские справочники из открытых источников

BSD-3-CLAUSE License

Downloads
41
Stars
12
Committers
1

ruopenrefs

https://github.com/idlesign/ruopenrefs

|release| |lic|

.. |release| image:: https://img.shields.io/pypi/v/ruopenrefs.svg :target: https://pypi.python.org/pypi/ruopenrefs

.. |lic| image:: https://img.shields.io/pypi/l/ruopenrefs.svg :target: https://pypi.python.org/pypi/ruopenrefs

Описание

Общероссийские справочники из открытых источников

Пакет позволяет получать данные различных справочников, используя [условно] открытые источники, из вашего кода на Python.

Зависимости


* Python 3.5+

Ставятся при установке данного пакета:

* `requests` - для обращений в веб
* `envbox` - для работы с настройками



Источники и справочники
-----------------------

Портал открытых данных Правительства Москвы

Расположение: ruopenrefs.providers.mosru

  • Общероссийский классификатор стран мира (ОКСМ)
  • Общероссийский классификатор валют (ОКВ)
  • Общероссийский классификатор территорий муниципальных образований (ОКТМО)
  • Общероссийский классификатор объектов административно-территориального деления (ОКАТО)
  • Общероссийский классификатор единиц измерения (ОКЕИ)

.. note:: Для доступа к данным этого поставщика требуется зарегистрироваться на https://apidata.mos.ru, получить ключ доступа к API, и проставить его в переменную окружения (либо в .env файле) RUOREFS_MOSRU_KEY.

Примеры использования:

.. code-block:: python

# Импортируем нужный класс справочника нужного провайдера
from ruopenrefs.providers.mosru import OksmRef

# Проходим по всем данным справочника (для примера справочник ОКСМ)
for item in OksmRef().iter_items():
    # Каждый item - это именованный кортеж.
    print(item)

Установка

Пакет ставится обычным для пакетов Python способом при помощи pip.

Дополнительная информация по установке находится в файле INSTALL.

Участие в разработке

К участию приглашаются все желающие.

Больше подробностей о том как принять участие в разработке можно найти в файле CONTRIBUTING.