Metadata-Version: 2.1
Name: here-nagini
Version: 1.10
Summary: Python SDK for HERE Services, especially HERE platform
Home-page: https://here.com
Author: HERE Global B.V. and its affiliate(s)
License: HERE Proprietary License
Project-URL: Source, ssh://git@main.gitlab.in.here.com:3389/sdk/nagini-python-sdk.git
Keywords: HERE Technologies
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: Other/Proprietary License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Version Control :: Git
Requires-Dist: aiohttp (==3.6.2)
Requires-Dist: backoff (>=1.10.0)
Requires-Dist: contextily (==1.0.0)
Requires-Dist: deprecated (==1.2.10)
Requires-Dist: fastparquet (==0.4.1)
Requires-Dist: geographiclib (==1.50)
Requires-Dist: geopandas (==0.8.1)
Requires-Dist: ipykernel (==5.3.4)
Requires-Dist: ipyleaflet (==0.13.3)
Requires-Dist: matplotlib (==3.3.0)
Requires-Dist: pandas (==1.1.0)
Requires-Dist: protobuf (==3.12.4)
Requires-Dist: pyarrow (==1.0.0)
Requires-Dist: pyhocon (==0.3.54)
Requires-Dist: requests (==2.24.0)
Requires-Dist: requests-oauthlib (==1.3.0)
Requires-Dist: selenium (==3.141.0)
Requires-Dist: shapely (==1.7.0)
Requires-Dist: timeout-decorator (==0.4.1)
Requires-Dist: descartes (==1.1.0)

Here Nagini — Python SDK for HERE Services
==========================================

.. contents:: **Table of Contents**
  :depth: 3

Introduction
------------

This repository contains the code for the project under the codename *Nagini*,
the Python SDK intended primarily for `HERE platform`_.
It also includes some little helpers to access other useful services,
like HERE Location Services.

The goal of this project is to provide an easier, more accessible way for using
HERE platform from the perspective of data scientists performing analytical tasks,
ideally with only a few lines of code and in a friendly, exploratory notebook
environment like Jupyter_.

The project is maintained by the HERE Analytics PySDK team, contact: OLP_PXP_SPACE_FORCE@here.com.


Directory layout
----------------

This is a rough overview of the top-level directory structure inside the
repository:

::

    +- docs             # documentation for the internal API.
    |
    +- examples         # examples, mini milestones, notebooks.
    |
    +- nagini
    |  |
    |  +- core
    |  |  |
    |  |  +- hls        # HLS
    |  |  |
    |  |  +- olp        # OLP
    |  |
    |  +- utils         # utilities and helpers.
    |
    +- tests
       |
       +- assets        # assets used in the tests
       |
       +- integration   # integration tests.
       |
       +- performance   # performance tests.
       |
       +- unit          # unit tests.


Development setup for end users
-------------------------------

Install instructions
....................

Setup Guide: https://developer.here.com/documentation/sdk-python/dev_guide/index.html


Documentation
.............

The available documentation consists of the example notebooks inside the
``examples`` directory, and the internal API reference which is auto-generated
during CI/CD builds and served online as static GitLab *pages* here:

https://sdk.pages.gitlab.in.here.com/nagini-python-sdk/

Use the Python API Reference to leverage the full functionality of the SDK for Python. This reference includes a wealth of commands to help analyze, visualize and process data easily.

API Reference: https://developer.here.com/documentation/sdk-python/api_reference/index.html


Test instructions
.................

To run the entire test suite you only need to execute the following command:

.. code-block:: console

    $ make test

The tests are operating on a list of existing HERE platform catalogs for which you must
have access permissions. At the moment these catalogs are:

- `hrn:here:data::olp-here:oma-3 <https://platform.here.com/data/hrn:here:data::olp-here:oma-3>`_
- `hrn:here:data::olp-here:rib-2 <https://platform.here.com/data/hrn:here:data::olp-here:rib-2>`_
- `hrn:here:data::olp-here:live-weather-eu <https://platform.here.com/data/hrn:here:data::olp-here:live-weather-eu>`_
- `hrn:here:data::olp-here:here-geojson-samples <https://platform.here.com/data/hrn:here:data::olp-here:here-geojson-samples>`_
- `hrn:here:data::olp-here:olp-sdii-sample-berlin-2 <https://platform.here.com/data/hrn:here:data::olp-here:olp-sdii-sample-berlin-2>`_


Code Style instructions
.......................

To format code using black and isort, code formatting tools execute following command:

.. code-block:: console

    $ make format


Jupyter configuration
.....................

To enable ipyleaflet in JupyterLab_, you also need to install the JupyterLab extension:

.. code-block:: console

    $ jupyter labextension install jupyter-leaflet

For some users it is also required to install the jupyterlab-manager extension

.. code-block:: console

    jupyter labextension install @jupyter-widgets/jupyterlab-manager

Running examples in the Docker container
........................................

Build your own Docker: https://developer.here.com/documentation/sdk-python/dev_guide/topics/docker/home.html


Support
-------

The best way to get support is to create a Jira Issue_,

.. _Issue: https://saeljira.it.here.com/secure/CreateIssue!default.jspa

Or for more general discussion you can subscribe the `HERE Analytics SDK`_ Yammer group:

.. _HERE Analytics SDK: https://www.yammer.com/here.com/#/threads/inGroup?type=in_group&feedId=17776308&view=all

Contribution
------------

See `CONTRIBUTING.rst`_

.. _CONTRIBUTING.rst: ./CONTRIBUTING.rst

License
-------

Copyright (C) 2019-2020 HERE Europe B.V.

See the LICENSE_ file in the root of this project for license details.


.. _HERE platform: https://platform.here.com
.. _Jupyter: https://jupyter.org/
.. _JupyterLab: https://jupyterlab.readthedocs.io/
.. _LICENSE: ./LICENSE


