Python UrbanTZ client
=====================

:ref:`genindex` - :ref:`modindex` - :ref:`search`

.. image:: https://img.shields.io/pypi/v/pyurbantz.svg
   :target: https://pypi.org/project/pyurbantz

.. image:: https://img.shields.io/pypi/l/pyurbantz.svg
   :target: https://pypi.org/project/pyurbantz

.. image:: https://img.shields.io/pypi/format/pyurbantz.svg
   :target: https://pypi.org/project/pyurbantz

.. image:: https://img.shields.io/pypi/pyversions/pyurbantz.svg
   :target: https://pypi.org/project/pyurbantz

.. image:: https://img.shields.io/pypi/status/pyurbantz.svg
   :target: https://pypi.org/project/pyurbantz

.. image:: https://gitlab.com/Lucidiot/pyurbantz/badges/master/pipeline.svg
   :target: https://gitlab.com/Lucidiot/pyurbantz/pipelines

.. image:: https://requires.io/github/Lucidiot/pyurbantz/requirements.svg?branch=master
   :target: https://requires.io/github/Lucidiot/pyurbantz/requirements/?branch=master

.. image:: https://img.shields.io/github/last-commit/Lucidiot/pyurbantz.svg
   :target: https://gitlab.com/Lucidiot/pyurbantz/commits

.. image:: https://img.shields.io/badge/badge%20count-9-brightgreen.svg
   :target: https://gitlab.com/Lucidiot/pyurbantz

A Python package to help with an undocumented API of
`UrbanTZ <https://www.urbantz.com/>`_.

The UrbanTZ company provides a delivery management platform of the same name
for other companies. To provide delivery tracking to their customers, those
companies can send links to a tracking page on UrbanTZ's website, which uses
a unique delivery ID in the URL to show tracking information.

Those tracking pages perform requests to an undocumented API endpoint with this
tracking ID. The endpoint provides much more information than what is actually
used in the pages; this package aims to provide a Python interface to help
creating better tracking interfaces.

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

This package just needs `requests <https://python-requests.org>`_. That's it.

Scripts
-------

This package provides a simple tracker script, ``urbantz.tracker``, that can be
invoked like this::

   python -m urbantz.tracker <ID> [-f|--frequency <seconds>]

The script will perform a request every 10 seconds (by default) to the
UrbanTZ API, then print the current date, time and distance between the
delivery truck and the destination.

Other topics
------------

.. toctree::
   :maxdepth: 2

   contributing
   api