Improve README

[cleder]

Maybe with instructions how to convert kml to czml

[harvest422]

An example or two on useage would be most helpful!

[bobbymarko]

+1

[Frencil]

For the 0.3.1 release I've updated the README to include one complete usage example and a link to documentation on supported CZML components. Leaving issue open though as I did not add any information about KML/CZML coversion or a usage example on reading a CZML document.

[cleder]

Great Thanks :-)

[rothnic]

Just noticed that this was updated. I created a fork a while back in the middle of a push to get something done. This included fixing some things (i think you have handled this), adding doc strings to as much as possible, and integrating in sphinx docs.

If you'd like, we could see what we'd need to do to update this project with the changes.

Main docs page
main module documentation

[cleder]

@rothnic : this would be great! can you try to rebase or pull in the changes from master? @Frencil can you have a look?

[brianbreitsch]

Hmm, I just tried the example in the README and it seems incompatible with the current library.

I installed from pip. Is that the problem? Or does the README need to be updated?

[Frencil]

@brianbreitsch I just went through the examples in the README in both Python 2.x and 3.x and everything seems to be working. Can you be more specific about the incompatibility you found? What error message(s) did you see?

[brianbreitsch]

It works when I install from the repo--the package on pip was outdated I guess.

[Frencil]

Confirmed - just tried installing from pip in a virtualenv and it pulled down version 0.1dev for some reason - a way out of date version!

With a little more digging (pip install -v -v -v czml in a virtualenv) it appears my local version of pip skips .egg files, preferring .tar.gz files. Only version 0.1dev had that format, so that's what pip chose to install.

I updated the package on pypi to include a .tar.gz for the current version (0.3.2) and tried the virtualenv install again. This time it installed the current version. You should now be able to install from pip and get the correct version.

Thanks for helping identify that issue!