Skip to main content

Python 3 library to write CZML

Project description

Name:

czml3

Author:

Juan Luis Cano Rodríguez orcid

circleci codecov license Join the chat at https://chat.openastronomy.org/#/room/#poliastro-czml:matrix.org

czml3 is a Python library to write CZML.

What is CZML?

[TODO]

Installation

You can install czml3 using pip:

$ pip install czml3

czml3 requires Python >= 3.6. Would you like to help us supporting Python 3.5 as well?

Let us know if you want to lend a hand by making czml3 available on conda-forge too.

Examples

A CZML document is a list of packets, which have several properties. When using czml3 in an interactive interpreter, all objects show as nice CZML (JSON):

>>> from czml3 import Packet
>>> Packet()
{
    "id": "adae4d3a-7087-4fda-a70b-d18a262a890e"
}
>>> packet0 = Packet(id="Facility/AGI", name="AGI")
>>> packet0
{
    "id": "Facility/AGI",
    "name": "AGI"
}
>>> packet0.dumps()
'{"id": "Facility/AGI", "name": "AGI"}'

Check out the tests to get an idea of the current capabilities of the library.

Support

Join the chat at https://chat.openastronomy.org/#/room/#poliastro-czml:matrix.org

If you find any issue on czml3 or have questions, please open an issue on our repository and join our chat!

Contributing

You want to contribute? Awesome! There are lots of CZML properties that we still did not implement. Also, it would be great to have better validation, a Cesium widget in Jupyter notebook and JupyterLab… Ideas welcome!

We recommend this GitHub workflow to fork the repository. To run the tests, use tox:

$ tox

Before you send us a pull request, remember to reformat all the code:

$ tox -e reformat

This will apply black, isort, and lots of love ❤️

License

license

czml3 is released under the MIT license, hence allowing commercial use of the library. Please refer to the LICENSE file.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

czml3-0.1.0.tar.gz (26.7 kB view details)

Uploaded Source

Built Distribution

czml3-0.1.0-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file czml3-0.1.0.tar.gz.

File metadata

  • Download URL: czml3-0.1.0.tar.gz
  • Upload date:
  • Size: 26.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for czml3-0.1.0.tar.gz
Algorithm Hash digest
SHA256 34788aa89ea5a46cc1d2f03dec6fe5601d53b89e8291f00037ff74756e572978
MD5 9dcef0166a43b49bce4a9cf7f00917c4
BLAKE2b-256 4c5ce2955e16911e6040c2de2eaba85e6a1dbe80ab0c10f4773f0a6f26fc4d81

See more details on using hashes here.

File details

Details for the file czml3-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: czml3-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for czml3-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d087d3f19157c1e69d6ccd1dfc1251b5dc359cdb8a03d22c0dc5b68376b94cbc
MD5 4d1f5836236c8f5ae583d909d5a8f605
BLAKE2b-256 de6f8f9c06eb2a15f36c9c2775475c1e9b87f433fb7eeeaa80e55ef655e03763

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page