A Python 3 library built on the Mapillary API v4 to facilitate retrieving and working with Mapillary data
Project description
Mapillary Python SDK
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,
make setup-dev: Install developer dependenciesmake build: Build the packagemake 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
- Christopher Beddow - for leading the project
- Saif Ul Islam - for developing the SDK under MLH fellowship
- Omar Ali - for developing the SDK under MLH fellowship
Links
More About Mapillary
Legal
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mapillary-1.0.7-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b49d7aae99eca5369552bd2ec357aeaa654a0bdb096af7f69d74d10e877b06e4 |
|
| MD5 | 55592365951fcbd219d0dd3fc7d251cb |
|
| BLAKE2b-256 | 780751fccaa13dc22d98fff5531077613fe6c6cce1a9a014601a0ca3a9211caa |
