Commit 8cb6fe4d authored by Christian Ledermann's avatar Christian Ledermann

Merge branch 'jean-master'

parents c8296c0f 0273cdb7
Introduction
============
Fastkml is a library to read, write and manipulate kml files. It aims to keep
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
......@@ -9,7 +9,8 @@ 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 shapely_ (if installed) objects.
Geometries are handled as pygeoif_ or, if installed, shapely_ objects.
.. _pygeoif: http://pypi.python.org/pypi/pygeoif/
.. _shapely: http://pypi.python.org/pypi/Shapely
......@@ -21,9 +22,11 @@ Fastkml is continually tested with *Travis CI*:
.. image:: https://api.travis-ci.org/cleder/fastkml.png
:target: https://travis-ci.org/cleder/fastkml
:alt: Tests
.. image:: https://coveralls.io/repos/cleder/fastkml/badge.png?branch=master
:target: https://coveralls.io/r/cleder/fastkml?branch=master
:alt: Coverage
Is Maintained and documented:
......@@ -38,6 +41,7 @@ Is Maintained and documented:
.. image:: https://readthedocs.org/projects/fastkml/badge/
:target: https://fastkml.readthedocs.org/
:alt: Documentation
.. image:: https://badge.waffle.io/cleder/fastkml.png?label=ready&title=Ready
:target: https://waffle.io/cleder/fastkml
......@@ -100,7 +104,7 @@ Limitations
===========
*Tesselate*, *Extrude* and *Altitude Mode* are assigned to a Geometry or
Geometry collection (MultiGeometry). You cannot assign diffrent values of
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
......
......@@ -17,7 +17,7 @@ Pull Requests
Start by submitting a pull request on GitHub against the `master` branch of the
repository. Your pull request should provide a good description of the change
you are making and or the bug that you are fixing. This will then trigger a
you are making, and/or the bug that you are fixing. This will then trigger a
build in `Travis-CI`_ where your contribution will be tested to verify it does
not break existing functionality.
......
......@@ -36,10 +36,10 @@ Supports python 2 and 3:
:target: https://pypi.python.org/pypi/fastkml/
:alt: Supported Python implementations
Fastkml is a library to read, write and manipulate kml files. It aims to keep
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 provides a subset of KML
spend to write and read KML files, as well as the time you spend to get
acquainted with the library or to create KML objects. It provides a subset of KML
and is aimed at documents that can be read from multiple clients such as
openlayers and google maps rather than to give you all functionality that KML
on google earth provides.
......@@ -51,18 +51,18 @@ developers site.
Rationale
---------
Why yet another KML library? None of the existing ones quite fitted my
Why yet another KML library? None of the existing ones quite fit my
requirements, namely:
* Fastkml can *read and write* KML files, feeding fastkmls output back into
fastkml and serializing it again will result in the same output.
* You can parse any kml snipppet, it does not need to be a complete KML
* fastkml can *read and write* KML files, feeding fastkml's output back into
fastkml and serializing it again will result in the same output.
* You can parse any KML snippet, it does not need to be a complete KML
document.
* It runs on python 2 and 3.
* It runs on Python 2 and 3.
* It is fully tested and actively maintained.
* Geometries are handled in the `__geo_interface__` standard.
* Minimal dependencies, pure python.
* If available lxml_ will be used to increase its speed.
* Minimal dependencies, pure Python.
* If available, lxml_ will be used to increase its speed.
.. toctree::
:maxdepth: 2
......
......@@ -13,7 +13,7 @@ fastkml works on Unix/Linux, OS X, and Windows.
Install it with ``pip install fastkml`` or ``easy_install fastkml``.
If you use fastkml extensively or need to process big kml files consider
If you use fastkml extensively or need to process big KML files, consider
installing lxml_ as it speeds up processing.
You can install all requirements for working with fastkml by using pip_ from
......
Usage Guide
===========
You can find more examples in the included ``test_main.py`` file or in
collective.geo.fastkml_, here is a quick overview:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment