marshmallow-jsonapi

Homepage: http://marshmallow-jsonapi.readthedocs.io/

JSON API 1.0 (https://jsonapi.org) formatting with marshmallow.

marshmallow-jsonapi provides a simple way to produce JSON API-compliant data in any Python web framework.

from marshmallow_jsonapi import Schema, fields


class PostSchema(Schema):
    id = fields.Str(dump_only=True)
    title = fields.Str()

    author = fields.Relationship(
        "/authors/{author_id}", related_url_kwargs={"author_id": "<author.id>"}
    )

    comments = fields.Relationship(
        "/posts/{post_id}/comments",
        related_url_kwargs={"post_id": "<id>"},
        # Include resource linkage
        many=True,
        include_resource_linkage=True,
        type_="comments",
    )

    class Meta:
        type_ = "posts"


post_schema = PostSchema()
post_schema.dump(post)
# {
#     "data": {
#         "id": "1",
#         "type": "posts"
#         "attributes": {
#             "title": "JSON API paints my bikeshed!"
#         },
#         "relationships": {
#             "author": {
#                 "links": {
#                     "related": "/authors/9"
#                 }
#             },
#             "comments": {
#                 "links": {
#                     "related": "/posts/1/comments/"
#                 }
#                 "data": [
#                     {"id": 5, "type": "comments"},
#                     {"id": 12, "type": "comments"}
#                 ],
#             }
#         },
#     }
# }

Installation

pip install marshmallow-jsonapi

Documentation

Full documentation is available at https://marshmallow-jsonapi.readthedocs.io/.

Requirements

Python >= 3.6

Project Links

Docs: http://marshmallow-jsonapi.readthedocs.io/
Changelog: http://marshmallow-jsonapi.readthedocs.io/en/latest/changelog.html
Contributing Guidelines: https://marshmallow-jsonapi.readthedocs.io/en/latest/contributing.html
PyPI: https://pypi.python.org/pypi/marshmallow-jsonapi
Issues: https://github.com/marshmallow-code/marshmallow-jsonapi/issues

License

MIT licensed. See the bundled LICENSE file for more details.

Metadata

Release files for marshmallow-jsonapi 0.24.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for marshmallow-jsonapi 0.24.0
File	Size	Uploaded
marshmallow-jsonapi-0.24.0.tar.gz	34.6 kB	Dec 27, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for marshmallow-jsonapi 0.24.0
File	Interpreter	ABI	Platform	Reset
marshmallow_jsonapi-0.24.0-py2.py3-none-any.whl 14.3 kB Dec 27, 2020	Python 2, Python 3	none	any	Details

Total release size: 48.9 kB

Release files / marshmallow-jsonapi-0.24.0.tar.gz

Download URL	marshmallow-jsonapi-0.24.0.tar.gz
Size	34.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`bd88c0ac0e2ddeb0a3ceb86229963b9f828d898041f29d92a68f585a1feb37b5`
BLAKE2b-256 checksum How to use checksums	`428e5148bdc8ffb44e03a259ac4c824d568ad9ce2653c63e216382ee94308bc3`
Upload date	Dec 27, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.0.post20201221 requests-toolbelt/0.9.1 tqdm/4.55.0 CPython/3.7.9`

Release files / marshmallow_jsonapi-0.24.0-py2.py3-none-any.whl

Download URL	marshmallow_jsonapi-0.24.0-py2.py3-none-any.whl
Size	14.3 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`b7403688297dfe8b89173582811989badbe1328ac36447c5a151c006fbe34d24`
BLAKE2b-256 checksum How to use checksums	`b6445cf50d083ac6e1ca654e1cbaab0342b1f231591a3cd184f72827eccfa9f3`
Upload date	Dec 27, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.0.post20201221 requests-toolbelt/0.9.1 tqdm/4.55.0 CPython/3.7.9`