Provides Python bindings for the Libosmium C++ library, a library for working with OpenStreetMap data in a fast and flexible manner.
Pyosmium works with Python >= 3.7. Pypy is known to not work.
The recommended way to install pyosmium is via pip:
pip install osmium
We provide binary wheels for Linux and Windows 64 for all actively maintained Python versions.
For other versions, a source wheel is provided. Make sure to install all external dependencies first. On Debian/Ubuntu-like systems, the following command installs all required packages:
sudo apt-get install build-essential cmake libboost-dev \
libexpat1-dev zlib1g-dev libbz2-dev
pyosmium has the following dependencies:
- libosmium >= 2.16.0
- protozero
- cmake
- Pybind11 >= 2.7
- expat
- libz
- libbz2
- Boost variant and iterator >= 1.41
- Python Requests
- Python setuptools
- Requests
- a C++17-compatible compiler (Clang 7+, GCC 8+)
Get the latest versions of libosmium, protozero and pybind11 source code. It is
recommended that you put them in a subdirectory contrib.
You can do this by cloning their repositories into that location.
Following commands should achieve this:
mkdir contrib
cd contrib
git clone https://github.com/osmcode/libosmium.git
git clone https://github.com/mapbox/protozero.git
git clone https://github.com/pybind/pybind11.git
You can also set custom locations with LIBOSMIUM_PREFIX, PROTOZERO_PREFIX and
PYBIND11_PREFIX respectively.
To use a custom boost installation, set BOOST_PREFIX.
To compile the bindings during development, you can use
build.
On Debian/Ubuntu-like systems, install python3-build, then
run:
python3 -m build -w
To compile and install the bindings, run
pip install .
The example directory contains small examples on how to use the library.
They are mostly ports of the examples in Libosmium and osmium-contrib.
There is a small test suite in the test directory. This provides unit test for the python bindings, it is not meant to be a test suite for Libosmium.
Testing requires pytest and pytest-httpserver. On Debian/Ubuntu install
the dependencies with:
sudo apt-get install python3-pytest python3-pytest-httpserver
or install them with pip using:
pip install osmium[tests]
The test suite can be run with:
pytest test
To build the documentation you need mkdocs with the mkdocstrings and jupyter extensions and the material theme.
All necessary packages can be installed via pip:
pip install osmium[docs]
To build the documentation run:
mkdocs build
or to few it locally, you can use:
mkdocs serve
For building the man pages for the tools run:
cd docs
make man
The man pages can be found in docs/man.
If you find bugs or have feature requests, please report those in the github issue tracker.
For general questions about using pyosmium you can use the OSM development mailing list or ask on OSM help.
Pyosmium is available under the BSD 2-Clause License. See LICENSE.TXT.
Sarah Hoffmann (lonvia@denofr.de)
