semvec/pypi-packages huggingface dataset:
hse-ruz 2.1.2
Python wrapper for HSE RUZ API
License: MIT License
Requires Python: >=3.5
Keywords: HSE RUZ API

hse_ruz
=======

.. image:: https://travis-ci.org/hell03end/hse_ruz.svg?branch=master
    :target: https://travis-ci.org/hell03end/hse_ruz
.. image:: https://badge.fury.io/py/hse_ruz.svg
    :target: https://badge.fury.io/py/hse_ruz

Python wrapper for HSE RUZ API.

**Versions under 2.1.0 are depreciated due to HSE RUZ API schema changes.**

`What's new?`__

__ https://github.com/hell03end/hse_ruz/wiki/Changelog


Requirements
------------

* Python >= 3.5 or latest PyPy3


Installation
------------

.. code-block:: bash

    pip install -U hse_ruz


Usage
-----

.. code-block:: python

    import ruz
    schedule = ruz.person_lessons("mymail@edu.hse.ru")

Module configuration performs throw setting environment variables:

* `HSE_RUZ_ENABLE_VERBOSE_LOGGING` - to enable verbose logging (`@log`)
* `HSE_RUZ_API_URL` - url to RUZ API, possible values (not all endpoints supported for 2, 3):

    1. `http://92.242.58.221/ruzservice.svc` - default
    2. `http://92.242.58.221/ruzservice.svc/v2`
    3. `https://www.hse.ru/api`

* `CHECK_EMAIL_ONLINE` - to enable online email verification (throw API call)


Contributing
------------

.. code-block:: bash

    git clone https://github.com/hell03end/hse_ruz.git
    cd hse_ruz
    pytest -v  # check requests schema is valid and etc.