Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/osmcode/pyosmium
Python bindings for libosmium
https://github.com/osmcode/pyosmium
openstreetmap python
Last synced: 3 days ago
JSON representation
Python bindings for libosmium
- Host: GitHub
- URL: https://github.com/osmcode/pyosmium
- Owner: osmcode
- License: bsd-2-clause
- Created: 2014-09-22T20:25:42.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-11-10T20:56:34.000Z (about 1 month ago)
- Last Synced: 2024-12-12T11:04:53.599Z (10 days ago)
- Topics: openstreetmap, python
- Language: Python
- Homepage: https://osmcode.org/pyosmium
- Size: 7.69 MB
- Stars: 318
- Watchers: 15
- Forks: 65
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.TXT
Awesome Lists containing this project
README
# pyosmium
Provides Python bindings for the [Libosmium](https://github.com/osmcode/libosmium) C++
library, a library for working with OpenStreetMap data in a fast and flexible
manner.
[](https://github.com/osmcode/pyosmium/actions?query=workflow%3ACI)
## Installation
Pyosmium works with Python >= 3.7. Pypy is known to not work.
### Using Pip
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
### Installing from source
#### Prerequisites
pyosmium has the following dependencies:
* [libosmium](https://github.com/osmcode/libosmium) >= 2.16.0
* [protozero](https://github.com/mapbox/protozero)
* [cmake](https://cmake.org/)
* [Pybind11](https://github.com/pybind/pybind11) >= 2.7
* [expat](https://libexpat.github.io/)
* [libz](https://www.zlib.net/)
* [libbz2](https://www.sourceware.org/bzip2/)
* [Boost](https://www.boost.org/) variant and iterator >= 1.41
* [Python Requests](https://docs.python-requests.org/en/master/)
* Python setuptools
* [Requests](https://requests.readthedocs.io)
* a C++17-compatible compiler (Clang 7+, GCC 8+)
### Compiling from Source
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](https://pypa-build.readthedocs.io/en/stable/).
On Debian/Ubuntu-like systems, install `python3-build`, then
run:
python3 -m build -w
To compile and install the bindings, run
pip install .
## Examples
The `example` directory contains small examples on how to use the library.
They are mostly ports of the examples in Libosmium and osmium-contrib.
## Testing
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
## Documentation
To build the documentation you need [mkdocs](https://www.mkdocs.org/)
with the [mkdocstrings](https://mkdocstrings.github.io/)
and [jupyter](https://github.com/danielfrg/mkdocs-jupyter) extensions
and the [material theme](https://squidfunk.github.io/mkdocs-material/).
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.
## Bugs and Questions
If you find bugs or have feature requests, please report those in the
[github issue tracker](https://github.com/osmcode/pyosmium/issues/).
For general questions about using pyosmium you can use the
[OSM development mailing list](https://lists.openstreetmap.org/listinfo/dev)
or ask on [OSM help](https://help.openstreetmap.org/).
## License
Pyosmium is available under the BSD 2-Clause License. See LICENSE.TXT.
## Authors
Sarah Hoffmann ([email protected])