Skip to main content

A Python 3 library built on the Mapillary API v4 to facilitate retrieving and working with Mapillary data

Project description

Mapillary Python SDK

Contributors Forks Stargazers Issues MIT License


LinkedIn Email Twitter Facebook

Mapillary's official Python SDK for GeoSpatial Data
Explore the docs »

View Demo · Report Bug · Request Feature · See Documentation

Table Of Contents

About

Mapillary's Python SDK provides an easy mechanism for accessing and retrieving information from Mapillary's web application.

For more information, please visit Mapillary and Mapillary's Blog.

Getting Started

Installation

To get started, simply install mapillary by running,

pip install mapillary

A quick demo,

"""
Getting image coordinates from a nearby set of coordinates
"""

# Importing mapillary
import mapillary.interface as mly

# JSON import
import json

# Get image points close to in the given coordinates
data = mly.get_image_close_to(longitude=31, latitude=30).to_dict()

# Save the data as JSON
file_name = "get_image_close_to_1.json"
with open(file_name, mode="w") as f:
    json.dump(data, f, indent=4)

You can check out all the implemented functionality from the demo.

Or you can check out the documentation!

Development

Formatting/Linting

To run the formatter black, and the linter flake8, run,

flake8 mapillary & black mapillary

Or, if you are on Linux, you can simply run,

make style

This runs the style policy from the Makefile.

Dev Setup

Aliases for setting up the environment have been provided in Makefile to reduce burden of replication.

The steps to execute are, in order of running them,

  1. make setup-dev: Install developer dependencies
  2. make build: Build the package
  3. make local-install: Install package locally in the dev environment

To use the new package installed locally, first use pipenv to change into the environment that the package was installed into by running,

pipenv shell

Then run,

python # assuming running python opens the Python3 shell

Then import and use as required,

# import package here
import mapillary.interface as mly

# more code to follow here

Trouble shooting

If you get messed up dependencies, feel free to delete the Pipfile.lock file with rm Pipfile.lock, then start again with the first step in Dev Setup.

If you ever need to start with a clean build, you can always run make clean which will clean the dist directory, then you can simply start again from the second step in Dev Setup.

Upgrading A Package

If you upgrade any package in Pipfile, be sure to run pipenv install to update the Pipfile.lock as well.

Possible Issues

Failed installation/dev setup because of libgeos_c.so or libgeos_c_1.so
With UNIX based systems, you would to install the `geos` package with you package manager.

In debian systems, sudo apt install geos. In arch based systems, sudo pacman -S geos.

Contributing

We welcome contributions! See CONTRIBUTING for details on how to get started, and our code of conduct.

Acknowledgements

Links

More About Mapillary

Legal

Download files

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

Source Distribution

mapillary-1.0.14.tar.gz (111.5 kB view details)

Uploaded Source

Built Distribution

mapillary-1.0.14-py3-none-any.whl (69.7 kB view details)

Uploaded Python 3

File details

Details for the file mapillary-1.0.14.tar.gz.

File metadata

  • Download URL: mapillary-1.0.14.tar.gz
  • Upload date:
  • Size: 111.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mapillary-1.0.14.tar.gz
Algorithm Hash digest
SHA256 c080f35696be21399ba4f7beb193331e7ccdcce1d5c9b2cca3434893d0f9afd5
MD5 05944532a0cafe96673d07764b5748ac
BLAKE2b-256 7a6322a7282b94a00bb1365b4ca3f53b0816f7f63b9729fe03e3e141ffc8a480

See more details on using hashes here.

Provenance

The following attestation bundles were made for mapillary-1.0.14.tar.gz:

Publisher: pypi-publish.yml on mapillary/mapillary-python-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mapillary-1.0.14-py3-none-any.whl.

File metadata

  • Download URL: mapillary-1.0.14-py3-none-any.whl
  • Upload date:
  • Size: 69.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mapillary-1.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 ed97b66edc0e949625508b8a282494a73dd678af1bdd0d1f80ca1cf46b4ad81d
MD5 927d6c0a9c464f1f805b47a5cb073c9f
BLAKE2b-256 9c0a47be379d3f459753308c15f749b6039c9ce690ca978a8640b9306fadf16e

See more details on using hashes here.

Provenance

The following attestation bundles were made for mapillary-1.0.14-py3-none-any.whl:

Publisher: pypi-publish.yml on mapillary/mapillary-python-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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