zpao/mapillary-python-sdk

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

Mapillary Python SDK

Internal Resources

Relevant Links

• Python naming conventions
• Building a Python Open Source Project
• Example geospatial Python library, which we can reference for inspiration
• Mapillary blog on API v4 examples
• Facebook Open Source Legal Terms
• Facebook Open Source Privacy Policy

mapillary-python-sdk -External Documentation

In this section, we keep a draft of the documentation.

here we should give a paragraph describing the library and what its capabilities are

Getting Started

How do I install the Mapillary Python SDK? See the installation instructions link to readthedocs.io.

How do I use the Mapillary Python SDK? See the usage examples and tutorials in the examples repo link to examples possibly.

How does this function work? Check out the documentation.

Basic Start

For installing pipenv, please see here.

To install packages from Pipfile,

pipenv install

To install a package under packages,

pipenv install [package_name]

To install a package under dev-packages,

pipenv install --dev [package_name]

To run python with pipenv,

pipenv run python

To enter the virtual environment, run,

pipenv shell

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.

Building package

To build the package, run python3 setup.py sdist bdist_wheel. To test out a local installation, run pip install -e ..

Contributing

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

License

Mapillary-Python-SDK is MIT licensed, as found in the LICENSE file.