HerePy
======
.. image:: https://github.com/abdullahselek/HerePy/workflows/HerePy%20CI/badge.svg
:target: https://github.com/abdullahselek/HerePy/actions
.. image:: https://img.shields.io/pypi/v/herepy.svg
:target: https://pypi.python.org/pypi/herepy/
.. image:: https://img.shields.io/pypi/pyversions/herepy.svg
:target: https://pypi.org/project/herepy
.. image:: https://codecov.io/gh/abdullahselek/HerePy/branch/master/graph/badge.svg
:target: https://codecov.io/gh/abdullahselek/HerePy
.. image:: https://pepy.tech/badge/herepy
:target: https://pepy.tech/project/herepy
.. image:: https://img.shields.io/conda/vn/conda-forge/herepy?logo=conda-forge
:target: https://anaconda.org/conda-forge/herepy
.. image:: https://anaconda.org/conda-forge/herepy/badges/latest_release_date.svg
:target: https://anaconda.org/conda-forge/herepy
.. image:: https://anaconda.org/conda-forge/herepy/badges/license.svg
:target: https://anaconda.org/conda-forge/herepy
Introduction
============
This library provides a pure Python interface for the `HERE API <https://developer.here.com/>`_. It works with Python versions 3.x.
`HERE <https://www.here.com/>`_ provides location based services. HERE exposes a `rest APIs <https://developer.here.com/documentation>`_ and this library is intended to make it even easier for Python programmers to use.
Installing
==========
You can install herepy using Python Package Index::
$ pip install herepy
Install with conda from the Anaconda conda-forge channel::
$ conda install -c conda-forge herepy
Install from its source repository on GitHub::
$ pip install -e git+https://github.com/abdullahselek/HerePy#egg=herepy
Getting the code
================
The code is hosted at https://github.com/abdullahselek/HerePy
Check out the latest development version anonymously with::
$ git clone git://github.com/abdullahselek/HerePy.git
$ cd HerePy
To install dependencies, run either::
$ pip install -r requirements.testing.txt
$ pip install -r requirements.txt
To install the minimal dependencies for production use (i.e., what is installed
with ``pip install herepy``) run::
$ pip install -r requirements.txt
Running Tests
=============
The test suite can be run against a single Python version which requires ``pip install pytest`` and optionally ``pip install pytest-cov`` (these are included if you have installed dependencies from ``requirements.testing.txt``)
To run the unit tests with a single Python version::
$ py.test -v
to also run code coverage::
$ py.test --cov=herepy
To run the unit tests against a set of Python versions::
$ tox
Models
======
The library utilizes models to represent various data structures returned by **herepy**::
* herepy.GeocoderResponse
* herepy.GeocoderReverseResponse
* herepy.RoutingResponse
* herepy.RoutingResponseV8
* herepy.RoutingMatrixResponse
* herepy.GeocoderAutoCompleteResponse
* herepy.PlacesResponse
* herepy.PublicTransitResponse
* herepy.RmeResponse
* herepy.TrafficIncidentResponse
* herepy.DestinationWeatherResponse
* herepy.EVChargingStationsResponse
* herepy.WaypointSequenceResponse
* herepy.TrafficFlowResponse
* herepy.TrafficFlowAvailabilityResponse
* herepy.IsolineRoutingResponse
API Clients
===========
Available API clients in **herepy**::
* herepy.DestinationWeatherApi
* herepy.EVChargingStationsApi
* herepy.FleetTelematicsApi
* herepy.GeocoderApi
* herepy.GeocoderAutoCompleteApi
* herepy.GeocoderReverseApi
* herepy.PlacesApi
* herepy.PublicTransitApi
* herepy.RmeApi
* herepy.RoutingApi
* herepy.TrafficApi
* herepy.IsolineRoutingApi
* herepy.MapTileApi
* herepy.VectorTileApi
* herepy.MapImageApi
Documentation
=============
View the latest herepy documentation at `https://herepy.abdullahselek.com/ <https://herepy.abdullahselek.com/>`_. You can view HERE's API documentation at: `https://developer.here.com/documentation <https://developer.here.com/documentation>`_.
Using
=====
The library provides a Python wrapper around the HERE APIs with different data models. To get started, check out the examples in the ``examples/`` folder or
read the documentation at `https://herepy.abdullahselek.com/ <https://herepy.abdullahselek.com/>`_. All API clients need an API key which you can get from `HERE Developer Portal <https://developer.here.com/>`_.
License
-------
MIT License
Copyright (c) 2017 Abdullah Selek
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Raw data
{
"_id": null,
"home_page": "https://github.com/abdullahselek/HerePy",
"name": "herepy",
"maintainer": "Abdullah Selek",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "abdullahselek.os@gmail.com",
"keywords": "here api, here technologies, here python api clients, rest api clients",
"author": "Abdullah Selek",
"author_email": "abdullahselek.os@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d5/2e/46f81614393686fe30b43c59c5354dddb763dfcc4e2536c7d7900f744234/herepy-3.6.5.tar.gz",
"platform": "Any",
"description": "HerePy\n======\n\n.. image:: https://github.com/abdullahselek/HerePy/workflows/HerePy%20CI/badge.svg\n :target: https://github.com/abdullahselek/HerePy/actions\n\n.. image:: https://img.shields.io/pypi/v/herepy.svg\n :target: https://pypi.python.org/pypi/herepy/\n\n.. image:: https://img.shields.io/pypi/pyversions/herepy.svg\n :target: https://pypi.org/project/herepy\n\n.. image:: https://codecov.io/gh/abdullahselek/HerePy/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/abdullahselek/HerePy\n\n.. image:: https://pepy.tech/badge/herepy\n :target: https://pepy.tech/project/herepy\n\n.. image:: https://img.shields.io/conda/vn/conda-forge/herepy?logo=conda-forge\n :target: https://anaconda.org/conda-forge/herepy\n\n.. image:: https://anaconda.org/conda-forge/herepy/badges/latest_release_date.svg\n :target: https://anaconda.org/conda-forge/herepy\n\n.. image:: https://anaconda.org/conda-forge/herepy/badges/license.svg\n :target: https://anaconda.org/conda-forge/herepy\n\nIntroduction\n============\n\nThis library provides a pure Python interface for the `HERE API <https://developer.here.com/>`_. It works with Python versions 3.x.\n\n`HERE <https://www.here.com/>`_ provides location based services. HERE exposes a `rest APIs <https://developer.here.com/documentation>`_ and this library is intended to make it even easier for Python programmers to use.\n\nInstalling\n==========\n\nYou can install herepy using Python Package Index::\n\n $ pip install herepy\n\nInstall with conda from the Anaconda conda-forge channel::\n\n $ conda install -c conda-forge herepy\n\nInstall from its source repository on GitHub::\n\n $ pip install -e git+https://github.com/abdullahselek/HerePy#egg=herepy\n\nGetting the code\n================\n\nThe code is hosted at https://github.com/abdullahselek/HerePy\n\nCheck out the latest development version anonymously with::\n\n $ git clone git://github.com/abdullahselek/HerePy.git\n $ cd HerePy\n\nTo install dependencies, run either::\n\n $ pip install -r requirements.testing.txt\n $ pip install -r requirements.txt\n\nTo install the minimal dependencies for production use (i.e., what is installed\nwith ``pip install herepy``) run::\n\n $ pip install -r requirements.txt\n\nRunning Tests\n=============\n\nThe test suite can be run against a single Python version which requires ``pip install pytest`` and optionally ``pip install pytest-cov`` (these are included if you have installed dependencies from ``requirements.testing.txt``)\n\nTo run the unit tests with a single Python version::\n\n $ py.test -v\n\nto also run code coverage::\n\n $ py.test --cov=herepy\n\nTo run the unit tests against a set of Python versions::\n\n $ tox\n\nModels\n======\n\nThe library utilizes models to represent various data structures returned by **herepy**::\n\n * herepy.GeocoderResponse\n * herepy.GeocoderReverseResponse\n * herepy.RoutingResponse\n * herepy.RoutingResponseV8\n * herepy.RoutingMatrixResponse\n * herepy.GeocoderAutoCompleteResponse\n * herepy.PlacesResponse\n * herepy.PublicTransitResponse\n * herepy.RmeResponse\n * herepy.TrafficIncidentResponse\n * herepy.DestinationWeatherResponse\n * herepy.EVChargingStationsResponse\n * herepy.WaypointSequenceResponse\n * herepy.TrafficFlowResponse\n * herepy.TrafficFlowAvailabilityResponse\n * herepy.IsolineRoutingResponse\n\nAPI Clients\n===========\n\nAvailable API clients in **herepy**::\n\n * herepy.DestinationWeatherApi\n * herepy.EVChargingStationsApi\n * herepy.FleetTelematicsApi\n * herepy.GeocoderApi\n * herepy.GeocoderAutoCompleteApi\n * herepy.GeocoderReverseApi\n * herepy.PlacesApi\n * herepy.PublicTransitApi\n * herepy.RmeApi\n * herepy.RoutingApi\n * herepy.TrafficApi\n * herepy.IsolineRoutingApi\n * herepy.MapTileApi\n * herepy.VectorTileApi\n * herepy.MapImageApi\n\nDocumentation\n=============\n\nView the latest herepy documentation at `https://herepy.abdullahselek.com/ <https://herepy.abdullahselek.com/>`_. You can view HERE's API documentation at: `https://developer.here.com/documentation <https://developer.here.com/documentation>`_.\n\nUsing\n=====\n\nThe library provides a Python wrapper around the HERE APIs with different data models. To get started, check out the examples in the ``examples/`` folder or\nread the documentation at `https://herepy.abdullahselek.com/ <https://herepy.abdullahselek.com/>`_. All API clients need an API key which you can get from `HERE Developer Portal <https://developer.here.com/>`_.\n\nLicense\n-------\n\nMIT License\n\nCopyright (c) 2017 Abdullah Selek\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A library that provides a Python interface to the HERE APIs",
"version": "3.6.5",
"project_urls": {
"Download": "https://pypi.org/pypi/herepy",
"Homepage": "https://github.com/abdullahselek/HerePy"
},
"split_keywords": [
"here api",
" here technologies",
" here python api clients",
" rest api clients"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eef7bfea9a02a55e69e2539989132ab4f46ac72114e42961d3e61a1bbdff8d4b",
"md5": "55d047fd042da54a06f6a500c09be048",
"sha256": "ee3fcb7d2e1751537b2f7ca7ffce3335f9910c7d7a8e2bce38dfb7503009e61f"
},
"downloads": -1,
"filename": "herepy-3.6.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "55d047fd042da54a06f6a500c09be048",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 53814,
"upload_time": "2024-10-20T17:19:51",
"upload_time_iso_8601": "2024-10-20T17:19:51.334779Z",
"url": "https://files.pythonhosted.org/packages/ee/f7/bfea9a02a55e69e2539989132ab4f46ac72114e42961d3e61a1bbdff8d4b/herepy-3.6.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d52e46f81614393686fe30b43c59c5354dddb763dfcc4e2536c7d7900f744234",
"md5": "b5d7f9d70da58db64ab9b11131ba1997",
"sha256": "210f13f3ba14eec77a4ddaba83468ca8917cd21235398a617ce8c8b74d82dc0a"
},
"downloads": -1,
"filename": "herepy-3.6.5.tar.gz",
"has_sig": false,
"md5_digest": "b5d7f9d70da58db64ab9b11131ba1997",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 68979,
"upload_time": "2024-10-20T17:19:53",
"upload_time_iso_8601": "2024-10-20T17:19:53.536849Z",
"url": "https://files.pythonhosted.org/packages/d5/2e/46f81614393686fe30b43c59c5354dddb763dfcc4e2536c7d7900f744234/herepy-3.6.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-20 17:19:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "abdullahselek",
"github_project": "HerePy",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "herepy"
}
JSON
