calamus is a library built on top of marshmallow to allow (de-)Serialization of Python classes to JSON-LD.
Project description
calamus: JSON-LD Serialization Library for Python
calamus is a library built on top of marshmallow to allow (de-)Serialization of Python classes to JSON-LD
Installation
calamus releases and development versions are available from PyPI. You can install it using any tool that knows how to handle PyPI packages.
With pip:
$ pip install calamus
Usage
Assuming you have a class like
class Book:
def __init__(self, _id, name):
self._id = _id
self.name = name
Declare schemes
You can declare a schema for serialization like
schema = fields.Namespace("http://schema.org/")
class BookSchema(JsonLDSchema):
_id = fields.Id()
name = fields.String(schema.name)
class Meta:
rdf_type = schema.Book
model = Book
The fields.Namespace class represents an ontology namespace.
Make sure to set rdf_type to the RDF triple type you want get and model to the python class this schema applies to.
Serializing objects (“Dumping”)
You can now easily serialize python classes to JSON-LD
book = Book(_id="http://example.com/books/1", name="Ilias")
jsonld_dict = BookSchema().dump(book)
#{
# "@id": "http://example.com/books/1",
# "@type": "http://schema.org/Book",
# "http://schema.org/name": "Ilias",
#}
jsonld_string = BookSchema().dumps(book)
#'{"@id": "http://example.com/books/1", "http://schema.org/name": "Ilias", "@type": "http://schema.org/Book"}')
Deserializing objects (“Loading”)
You can also easily deserialize JSON-LD to python objects
data = {
"@id": "http://example.com/books/1",
"@type": "http://schema.org/Book",
"http://schema.org/name": "Ilias",
}
book = BookSchema().load(data)
#<Book(_id="http://example.com/books/1", name="Ilias")>
Support
You can reach us on our Gitter Channel.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file calamus-0.3.3.tar.gz.
File metadata
- Download URL: calamus-0.3.3.tar.gz
- Upload date:
- Size: 16.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.0.10 CPython/3.8.5 Linux/5.8.7-arch1-1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 406fbecd8f2e7d703ca89115f4fe027019344c16b74604891b296283467e2f8b |
|
| MD5 | ad8c3d58e66274e8973318a950c8f22b |
|
| BLAKE2b-256 | bec2b9e2b407e3433305e87b5302aeacc09f85dd23d3632671dcbf26cb01bfa6 |
File details
Details for the file calamus-0.3.3-py3-none-any.whl.
File metadata
- Download URL: calamus-0.3.3-py3-none-any.whl
- Upload date:
- Size: 18.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.0.10 CPython/3.8.5 Linux/5.8.7-arch1-1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 86df8d249db27707c40f29b3a60e96206b8196b4f9fc1832c9cf2285ee22132d |
|
| MD5 | 4ab8d1aba816bc83e3b1eba0b3634d1c |
|
| BLAKE2b-256 | deac5dbe97237f91c26967bd2891b7016c7e3d91407f710fb2b3052a19a1fca6 |
