Skip to main content

Photon Python client

Project description

🗺 Light Photon client written in Python

Latest Version codecov Build Status License: MIT

Install

pip install pyphoton

Usage

Python Photon client allows you to make queries to Photon easily.

from pyphoton import Photon


client = Photon()
location = client.query('berlin', limit=1)

print (location.city)
print (location.latitude)
print (location.longitude)

Photon object accepts two parameters:

  • host: the url where Photon instance is running (default https://photon.komoot.de)

  • language: the preferred language (default is en)

You can pass to the query method the following parameters along the query string:

  • limit: limit number of results

  • language: force language in the query

  • latitude and longitude: use them to search with priority to a geo position

  • location_bias_scale: use to search with location bias

Location object (or objects if you don’t set limit=1) is generated from the json returned and contains all the information you need: name, state, street, city, osm attributes, extent_from.latitude, extent_from.longitude, extent_to.latitude, extent_to.longitude …

If there’s an with your query, a PhotonException will be raised

from pyphoton import Photon
from pyphoton.errors import PhotonException


client = Photon()
try:
    location = client.query('', limit=1)
except PhotonException as ex:
    print (ex)

WIP Features

  • Reverse search

  • BBox search

  • Method to fetch latest data

Run tests

pip install -r requirements-dev.txt
make test

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyphoton-0.9.1.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

pyphoton-0.9.1-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

Details for the file pyphoton-0.9.1.tar.gz.

File metadata

  • Download URL: pyphoton-0.9.1.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/18.2 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.1

File hashes

Hashes for pyphoton-0.9.1.tar.gz
Algorithm Hash digest
SHA256 77bc194d840fd811448ed4c908223a66d695dac2c5dcdaa08e37c425f8d616d5
MD5 8713b803abf1e08217039f47f0cbad00
BLAKE2b-256 033edcc5fc0890d24e041db00b1ae83263bcfc3858d7a48f06e101ff324ec8e5

See more details on using hashes here.

File details

Details for the file pyphoton-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: pyphoton-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 5.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/18.2 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.1

File hashes

Hashes for pyphoton-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 31b96b08d2c9552e08092f5e056c60aeb4b26e66b731ebf479d7363925703dc4
MD5 e560e7bd253f66b2e0754057d99e60f3
BLAKE2b-256 3468d0ba3ee71e184484740a2a3025cc4cb8ac5da2116c6ddf48f9d28ae8f42d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page