Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
# v2.3.0

* Forbid extra attributes to all models

# v2.2.3

* Correct inheritance of `PositionList`, `BoxDimensions()`, and `Rectangle()`
* Remove `HasAlignment()`

# v2.2.2

* Update license
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ From the official [CZML Guide](https://github.com/AnalyticalGraphicsInc/czml-wri
czml3 aims to make the process of writing CZML files in Python easy by:
- Type checking properties
- Cooercion of data to their required format
- Forbidding unrecognised properties
- Creating minimal CZML files

## Insallation
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ czml3 aims to make the process of writing CZML files in Python easy by:

* Type checking properties
* Cooercion of data to their required format
* Forbidding unrecognised properties
* Creating minimal CZML files

.. toctree::
Expand Down
9 changes: 7 additions & 2 deletions docs/user/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,17 @@ The goal of czml3 is to make the process of writing CZML files in Python easy. T
Type Checking
-------------

czml3 is built using Pydantic. Therefore, all classes enforces type checking on the inputs. This ensures that the data is in the correct format before it is written to the CZML file.
All classes enforces type checking on the inputs. This ensures that the data is in the correct format before it is written to the CZML file.

Cooercion of Data
-----------------

Again, czml3 is build using Pydantic. Therefore, czml3 is able to `coerce data to their right type <https://docs.pydantic.dev/latest/why/#json-schema>`_. See Example 2 in :ref:`examples-label`.
czml3 `coerces data to their right type <https://docs.pydantic.dev/latest/why/#json-schema>`_. See Example 2 in :ref:`examples-label`.

Forbid Unrecognised Properties
------------------------------

czml3 raises an error if a model (class) receives an unrecognised input.

Minimal CZML File Creation
--------------------------
Expand Down
Loading