Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 2.8 KB

README.md

File metadata and controls

50 lines (33 loc) · 2.8 KB
Raw

What is pyLiveKML?

pyLiveKML is an implementation of Google's Keyhole Markup Language (KML) that enables an (approximately) live feed of geospatial information into Google Earth Pro (GEP). GEP is updated on the fly using an implementation of the mechanism described in Google's documentation. KML tags are automatically created, updated and deleted as necessary.

Several simple evaluation apps are included with the pyLiveKML source. These projects use Uvicorn and FastAPI to serve KML files to GEP, and to serve HTML etc files to provide a user interface via a browser.

Has the entire KML specification been implemented?

No. Only a subset of the KML classes that are described in the KML specification has been implemented at this time; see the pyLiveKML documentation for a list. The subset was chosen based on the author's personal experience, i.e. what has proven "useful" to me in the past. The list of supported classes could certainly be expanded.

GIS and OS Compatibility

pyLiveKML has been tested:

  • Serving to Google Earth Pro on Microsoft Windows 10 with HTTP and HTTPS
  • Serving from Python 3.10 on Windows 10
  • Serving from Python 3.10 on Ubuntu 22.04

It is possible that pyLiveKML may work with other KML-compliant GIS's and/or other operating systems, but no such alternatives have been researched or tested by the author.

Evaluation Applications

It will likely be necessary to set the PYTHONPATH environment variable before running the eval server as-is from the commandline:

  • Windows: set PYTHONPATH=<pyLiveKML root path>
  • Linux: export PYTHONPATH=<pyLiveKML root path>

If GEP is started without any arguments, you will need to add a new NetworkLink object to "Temporary Places", with the link address set to the URI of the loader.kml file, e.g. http(s)://addr:port/loader.kml. GEP will not load loader.kml from the URI using File->Open. However, if you start GEP with the URI of loader.kml as an argument, then it will load loader.kml on startup.

Documentation

Licence

Contributions

I'm willing to do a certain amount of work expanding the KML classes and attributes that are supported by pyLiveKML.

If you want me to write a customized server implementation and/or another format of UI, that would be paid work.