========
pyosmium
========

This library provides Python bindings for the `Libosmium`_ C++
library, a library for working with OpenStreetMap data in a fast and flexible
manner.

.. _Libosmium: https://github.com/osmcode/libosmium

Installation
============

pyosmium can be installed with pip:

    pip install osmium

The Pypi source package already comes bundled with a matching version of
libosmium. The library uses `Boost.Python`_ to create the C++ bindings.
On Debian/Ubuntu install `libboost-python-dev`. 
On OS X run `brew install boost-python` or `brew install boost-python --with-python3`
depending on which python version you want to use. You can also (re)install both.

Python >= 2.7 is supported but a version >= 3.3 is strongly recommended.

Other dependencies are expat, libz, and libbz2. See `Libosmium dependencies`_
for required packages for various distributions.

.. _Boost.Python: http://www.boost.org/doc/libs/1_56_0/libs/python/doc/index.html
.. _Libosmium dependencies: https://github.com/osmcode/libosmium/wiki/Libosmium-dependencies

Documentation
=============

The documentation for the latest release is available at
`osmcode.org`_.

.. _osmcode.org: http://docs.osmcode.org/pyosmium/latest

Examples
========

The package contains an `example` directory with small examples on how to use
the library. They are mostly ports of the examples in Libosmium and
osmium-contrib.

Fineprint
=========

Pyosmium is available under the BSD 2-Clause License. See LICENSE.TXT.

The source code can be found on `GitHub`_. There is also the issue tracker
for reporting bugs.

.. _GitHub: https://github.com/osmcode/pyosmium
