fastkml

Introduction

.. inclusion-marker-do-not-remove

KML is an XML geospatial data format and an OGC_ standard that deserves a canonical python implementation.

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 acquainted to the library or to create KML objects. It aims to provide all of the functionality that KML clients such as Marble <https://marble.kde.org/>, NASA WorldWind <https://github.com/NASAWorldWind>, Cesium JS <https://cesium.com/>, OpenLayers <https://openlayers.org/>, Google Maps <http://maps.google.com/>, and Google Earth <http://earth.google.com/> support.

For more details about the KML Specification, check out the KML Reference <https://developers.google.com/kml/documentation/kmlreference>_ on the Google developers site.

Geometries are handled as pygeoif_ objects, which are compatible with any geometry that implements the __geo_interface__ protocol, such as shapely_.

Fastkml is tested on CPython <https://python.org>_ and PyPy <https://www.pypy.org/>_, but it should work on alternative Python implementations (that implement the language specification >=3.8) as well.

|test| |hypothesis| |cov| |black| |mypy| |commit|

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

.. |hypothesis| image:: https://img.shields.io/badge/hypothesis-tested-brightgreen.svg :alt: Tested with Hypothesis :target: https://hypothesis.readthedocs.io

.. |cov| image:: https://codecov.io/gh/cleder/fastkml/branch/main/graph/badge.svg?token=VIuhPHq0ow :target: http://codecov.io/github/cleder/fastkml?branch=main :alt: codecov.io

.. |black| image:: https://img.shields.io/badge/code_style-black-000000.svg :target: https://github.com/psf/black :alt: Black

.. |mypy| image:: https://img.shields.io/badge/type_checker-mypy-blue :target: http://mypy-lang.org/ :alt: Mypy

.. |commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit :target: https://github.com/pre-commit/pre-commit :alt: pre-commit

Is maintained and documented:

|pypi| |conda-forge| |status| |license| |doc| |stats| |pyversion| |pyimpl| |dependencies| |downloads|

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

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

.. |license| image:: https://img.shields.io/pypi/l/fastkml :target: https://www.gnu.org/licenses/lgpl-3.0.en.html :alt: LGPL - License

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

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

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

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

.. |dependencies| image:: https://img.shields.io/librariesio/release/pypi/fastkml :target: https://libraries.io/pypi/fastkml :alt: Libraries.io dependency status for latest release

.. |downloads| image:: https://static.pepy.tech/badge/fastkml/month :target: https://pepy.tech/project/fastkml :alt: Downloads

.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/fastkml.svg :target: https://anaconda.org/conda-forge/fastkml :alt: Conda-Forge

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 which will pull in all requirements.

Requirements

• pygeoif_
• arrow_

Optional

• lxml_:

.. code-block:: bash

pip install "fastkml[lxml]"

Limitations

Currently, the only major feature missing for the full Google Earth experience is the gx extension <https://developers.google.com/kml/documentation/kmlreference#kmlextensions>_. Please submit a PR with the features you'd like to see implemented.

.. _pygeoif: https://pypi.python.org/pypi/pygeoif/ .. _lxml: https://pypi.python.org/pypi/lxml .. _arrow: https://pypi.python.org/pypi/arrow .. _OGC: https://www.ogc.org/standard/kml/ .. _shapely: https://shapely.readthedocs.io/