Introduction

Fastkml is a library to read, write and manipulate KML files. It aims to keep it simple and fast (using lxml_ if available). Fast refers to the time you spend to write and read KML files as well as the time you spend to get aquainted to the library or to create KML objects. It aims to provide all of the functionality that KML clients such as OpenLayers <http://openlayers.org/>, Google Maps <http://maps.google.com/>, and Google Earth <http://earth.google.com/>_ provides.

Geometries are handled as pygeoif_ or, if installed, shapely_ objects.

.. _pygeoif: http://pypi.python.org/pypi/pygeoif/ .. _shapely: http://pypi.python.org/pypi/Shapely .. _lxml: https://pypi.python.org/pypi/lxml .. _dateutils: https://pypi.python.org/pypi/dateutils .. _pip: https://pypi.python.org/pypi/pip

Fastkml is continually tested

.. image:: https://github.com/cleder/fastkml/actions/workflows/run-all-tests.yml/badge.svg?branch=master :target: https://github.com/cleder/fastkml/actions/workflows/run-all-tests.yml :alt: Test

.. image:: http://codecov.io/github/cleder/fastkml/coverage.svg?branch=master :target: http://codecov.io/github/cleder/fastkml?branch=master :alt: codecov.io

Is Maintained and documented:

.. image:: https://img.shields.io/pypi/v/fastkml.svg :target: https://pypi.python.org/pypi/fastkml :alt: Latest PyPI version

.. image:: https://img.shields.io/pypi/status/fastkml.svg :target: https://pypi.python.org/pypi/fastkml/ :alt: Development Status

.. image:: https://readthedocs.org/projects/fastkml/badge/ :target: https://fastkml.readthedocs.org/ :alt: Documentation

.. image:: https://www.openhub.net/p/fastkml/widgets/project_thin_badge.gif :target: https://www.openhub.net/p/fastkml :alt: Statistics from OpenHub

Supports python 2 and 3:

.. image:: https://img.shields.io/pypi/pyversions/fastkml.svg :target: https://pypi.python.org/pypi/fastkml/ :alt: Supported Python versions

.. image:: https://img.shields.io/pypi/implementation/fastkml.svg :target: https://pypi.python.org/pypi/fastkml/ :alt: Supported Python implementations

Documentation

You can find all of the documentation for FastKML at fastkml.readthedocs.org <https://fastkml.readthedocs.org>. If you find something that is missing, please submit a pull request on GitHub <https://github.com/cleder/fastkml> with the improvement.

Install

You can install the package with pip install fastkml or easy_install fastkml which should also pull in all requirements.

Requirements

• pygeoif_
• dateutils_

Optional

• lxml_
• shapely_

You can install all of the requirements for working with FastKML by using pip_::

pip install -r requirements.txt

.. note::

Shapely_ requires that libgeos be installed on your system. ``apt-get
install libgeos-dev`` will install these requirements for you on Debian-
based systems.

Limitations

Tesselate, Extrude and Altitude Mode are assigned to a Geometry or Geometry collection (MultiGeometry). You cannot assign different values of Tesselate, Extrude or Altitude Mode on parts of a MultiGeometry.

Currently, the only major feature missing for the full Google Earth experience is the gx extension <https://developers.google.com/kml/documentation/kmlreference#kmlextensions>_. This will most likely be added after the 1.0 version release.

Changelog

0.12 (2020/09/23)

• add track and multi track [dericke]
• remove travis, add github actions
• raise error and debug log for no geometries found case [hyperknot]
• protect AttributeError from data element without value [fpassaniti]
• examples and fixes [heltonbiker]
• improve documentation [whatnick]

0.11.1 (2015/07/13)

• add travis deploy to travis.yml

0.11 (2015/07/10)

• handle coordinates tuples which contain spaces

0.10 (2015/06/09)

• Fix bug when the fill or outline attributes of a PolyStyle are float strings

0.9 (2014/10/17)

• Add tox.ini for running tests using tox [Ian Lee]
• Add documentation, hosted at https://fastkml.readthedocs.org [Ian Lee]

0.8 (2014/09/18)

• Add support for address and phoneNumber [Ian Lee]
• Add support for Ground Overlay kml [Ian Lee]

0.7 (2014/08/01)

• Handle case where Document booleans (visibility,isopen) are 'true' or 'false' [jwhelland]
• test case additions and lxml warning [Ian Lee]
• pep8-ify source code (except test_main.py) [Ian Lee]
• pyflakes-ify source code (except init.py) [Ian Lee]

0.6 (2014/05/29)

• add Schema
• add SchemaData
• make use of lxmls default namespace

0.5 (2013/10/23)

• handle big files with huge_tree for lxml [Egil Moeller]
• bugfixes

0.4 (2013/09/05)

• adds the ability to add untyped extended data / named value pairs [Denis Krienbuehl]

0.3 (2012/11/15)

• specify minor python versions tested with Travis CI
• add support for tesselation, altitudeMode and extrude to Geometries
• move implementation of geometry from kml.Placemark to geometry.Geometry
• add support for heterogenous GeometryCollection
• python 3 compatible
• fix test for python 3
• change license to LGPL
• register namespaces for a more pleasant, human readable xml output

0.2 (2012/07/27)

• remove dependency on shapely
• add more functionality

0.1.1 (2012/06/29)

• add MANIFEST.in

0.1 (2012/06/27)

• initial release