marshmallow-sqlalchemy

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Description: **********************
marshmallow-sqlalchemy
**********************

|pypi-package| |build-status| |docs|

Homepage: https://marshmallow-sqlalchemy.readthedocs.io/

`SQLAlchemy <http://www.sqlalchemy.org/>`_ integration with the `marshmallow <https://marshmallow.readthedocs.io/en/latest/>`_ (de)serialization library.

Declare your models
===================

.. code-block:: python

import sqlalchemy as sa
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import scoped_session, sessionmaker, relationship, backref

engine = sa.create_engine('sqlite:///:memory:')
session = scoped_session(sessionmaker(bind=engine))
Base = declarative_base()

class Author(Base):
__tablename__ = 'authors'
id = sa.Column(sa.Integer, primary_key=True)
name = sa.Column(sa.String)

def __repr__(self):
return '<Author(name={self.name!r})>'.format(self=self)

class Book(Base):
__tablename__ = 'books'
id = sa.Column(sa.Integer, primary_key=True)
title = sa.Column(sa.String)
author_id = sa.Column(sa.Integer, sa.ForeignKey('authors.id'))
author = relationship("Author", backref=backref('books'))

Base.metadata.create_all(engine)

Generate marshmallow schemas
============================

.. code-block:: python

from marshmallow_sqlalchemy import ModelSchema

class AuthorSchema(ModelSchema):
class Meta:
model = Author

class BookSchema(ModelSchema):
class Meta:
model = Book
# optionally attach a Session
# to use for deserialization
sqla_session = session

author_schema = AuthorSchema()

(De)serialize your data
=======================

.. code-block:: python

author = Author(name='Chuck Paluhniuk')
book = Book(title='Fight Club', author=author)
session.add(author)
session.add(book)
session.commit()

author_schema.dump(author).data
# {'books': [123], 'id': 321, 'name': 'Chuck Paluhniuk'}

author_schema.load(dump_data, session=session).data
# <Author(name='Chuck Paluhniuk')>

Get it now
==========
::

pip install -U marshmallow-sqlalchemy

Documentation
=============

Documentation is available at https://marshmallow-sqlalchemy.readthedocs.io/ .

Project Links
=============

- Docs: https://marshmallow-sqlalchemy.readthedocs.io/
- Changelog: https://marshmallow-sqlalchemy.readthedocs.io/en/latest/changelog.html
- PyPI: https://pypi.python.org/pypi/marshmallow-sqlalchemy
- Issues: https://github.com/marshmallow-code/marshmallow-sqlalchemy/issues

License
=======

MIT licensed. See the bundled `LICENSE <https://github.com/marshmallow-code/marshmallow-sqlalchemy/blob/dev/LICENSE>`_ file for more details.

.. |pypi-package| image:: https://badge.fury.io/py/marshmallow-sqlalchemy.svg
:target: http://badge.fury.io/py/marshmallow-sqlalchemy
:alt: Latest version
.. |build-status| image:: https://travis-ci.org/marshmallow-code/marshmallow-sqlalchemy.svg?branch=dev
:target: https://travis-ci.org/marshmallow-code/marshmallow-sqlalchemy
:alt: Travis-CI
.. |docs| image:: https://readthedocs.org/projects/marshmallow-sqlalchemy/badge/
:target: http://marshmallow-sqlalchemy.readthedocs.io/
:alt: Documentation

Keywords: sqlalchemy marshmallow
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6

Release files for marshmallow-sqlalchemy 0.13.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-sqlalchemy 0.13.0
File	Size	Uploaded
marshmallow-sqlalchemy-0.13.0.tar.gz	38.6 kB	Mar 12, 2017	Details

Built distribution (wheel)

Table of built distributions (wheels) for marshmallow-sqlalchemy 0.13.0
File	Interpreter	ABI	Platform	Reset
marshmallow_sqlalchemy-0.13.0-py2.py3-none-any.whl 12.8 kB Mar 12, 2017	Python 3, Python 2	none	any	Details

Total release size: 51.4 kB

Release files / marshmallow-sqlalchemy-0.13.0.tar.gz

Download URL	marshmallow-sqlalchemy-0.13.0.tar.gz
Size	38.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`5fe16dee2e2baafb3d6ae9cfb1a69050c7e12814be21b0d72fba13cc8fd2a37d`
BLAKE2b-256 checksum How to use checksums	`cc3ce68685d7c8a39e8d54734fd0ae3262f1a5c55dd3aef1b345e0299a5178b4`
Upload date	Mar 12, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / marshmallow_sqlalchemy-0.13.0-py2.py3-none-any.whl

Download URL	marshmallow_sqlalchemy-0.13.0-py2.py3-none-any.whl
Size	12.8 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`ec552b410e933f00d30efdd72396f935f66ed0a84bd560e83ee1704f1d718f2f`
BLAKE2b-256 checksum How to use checksums	`1688026b32cb6c56138f203e86152f04344fbc812abd2d29e706fc0a991211eb`
Upload date	Mar 12, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No