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: *****************
Flask-Marshmallow
*****************
|pypi-package| |build-status| |docs|
Flask + marshmallow for beautiful APIs
======================================
Flask-Marshmallow is a thin integration layer for `Flask`_ (a Python web framework) and `marshmallow`_ (an object serialization/deserialization library) that adds additional features to marshmallow, including URL and Hyperlinks fields for HATEOAS-ready APIs. It also (optionally) integrates with `Flask-SQLAlchemy <http://flask-sqlalchemy.pocoo.org/>`_.
Get it now
----------
::
pip install flask-marshmallow
Create your app.
.. code-block:: python
from flask import Flask, jsonify
from flask_marshmallow import Marshmallow
app = Flask(__name__)
ma = Marshmallow(app)
Write your models.
.. code-block:: python
from your_orm import Model, Column, Integer, String, DateTime
class User(Model):
email = Column(String)
password = Column(String)
date_created = Column(DateTime, auto_now_add=True)
Define your output format with marshmallow.
.. code-block:: python
class UserSchema(ma.Schema):
class Meta:
# Fields to expose
fields = ('email', 'date_created', '_links')
# Smart hyperlinking
_links = ma.Hyperlinks({
'self': ma.URLFor('user_detail', id='<id>'),
'collection': ma.URLFor('users')
})
user_schema = UserSchema()
users_schema = UserSchema(many=True)
Output the data in your views.
.. code-block:: python
@app.route('/api/users/')
def users():
all_users = User.all()
result = users_schema.dump(all_users)
return jsonify(result.data)
# OR
# return user_schema.jsonify(all_users)
@app.route('/api/users/<id>')
def user_detail(id):
user = User.get(id)
return user_schema.jsonify(user)
# {
# "email": "fred@queen.com",
# "date_created": "Fri, 25 Apr 2014 06:02:56 -0000",
# "_links": {
# "self": "/api/users/42",
# "collection": "/api/users/"
# }
# }
http://flask-marshmallow.readthedocs.io/
========================================
Learn More
==========
To learn more about marshmallow, check out its `docs <http://marshmallow.readthedocs.io/en/latest/>`_.
Project Links
=============
- Docs: https://flask-marshmallow.readthedocs.io/
- Changelog: http://flask-marshmallow.readthedocs.io/en/latest/changelog.html
- PyPI: https://pypi.python.org/pypi/flask-marshmallow
- Issues: https://github.com/marshmallow-code/flask-marshmallow/issues
License
=======
MIT licensed. See the bundled `LICENSE <https://github.com/marshmallow-code/flask-marshmallow/blob/master/LICENSE>`_ file for more details.
.. _Flask: http://flask.pocoo.org
.. _marshmallow: http://marshmallow.readthedocs.io
.. |pypi-package| image:: https://badge.fury.io/py/flask-marshmallow.svg
:target: http://badge.fury.io/py/flask-marshmallow
:alt: Latest version
.. |build-status| image:: https://travis-ci.org/marshmallow-code/flask-marshmallow.svg?branch=pypi
:target: https://travis-ci.org/marshmallow-code/flask-marshmallow
:alt: Travis-CI
.. |docs| image:: https://readthedocs.org/projects/flask-marshmallow/badge/
:target: http://flask-marshmallow.readthedocs.io/
:alt: Documentation
Keywords: flask-marshmallow
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
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
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Raw data
{
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"upload_time": "2018-04-29 12:54:33",
"author": "Steven Loria",
"home_page": "https://github.com/marshmallow-code/flask-marshmallow",
"github_user": "marshmallow-code",
"download_url": "https://files.pythonhosted.org/packages/91/f1/6ae4d3ff96c8c29245ffc2235feb322b323f5cf7c4ed69ce477e6d2aa848/flask-marshmallow-0.9.0.tar.gz",
"platform": "",
"version": "0.9.0",
"description": "Permission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\nDescription: *****************\n Flask-Marshmallow\n *****************\n \n |pypi-package| |build-status| |docs|\n \n Flask + marshmallow for beautiful APIs\n ======================================\n \n Flask-Marshmallow is a thin integration layer for `Flask`_ (a Python web framework) and `marshmallow`_ (an object serialization/deserialization library) that adds additional features to marshmallow, including URL and Hyperlinks fields for HATEOAS-ready APIs. It also (optionally) integrates with `Flask-SQLAlchemy <http://flask-sqlalchemy.pocoo.org/>`_.\n \n Get it now\n ----------\n ::\n \n pip install flask-marshmallow\n \n \n Create your app.\n \n .. code-block:: python\n \n from flask import Flask, jsonify\n from flask_marshmallow import Marshmallow\n \n app = Flask(__name__)\n ma = Marshmallow(app)\n \n Write your models.\n \n .. code-block:: python\n \n from your_orm import Model, Column, Integer, String, DateTime\n \n class User(Model):\n email = Column(String)\n password = Column(String)\n date_created = Column(DateTime, auto_now_add=True)\n \n \n Define your output format with marshmallow.\n \n .. code-block:: python\n \n \n class UserSchema(ma.Schema):\n class Meta:\n # Fields to expose\n fields = ('email', 'date_created', '_links')\n # Smart hyperlinking\n _links = ma.Hyperlinks({\n 'self': ma.URLFor('user_detail', id='<id>'),\n 'collection': ma.URLFor('users')\n })\n \n user_schema = UserSchema()\n users_schema = UserSchema(many=True)\n \n \n Output the data in your views.\n \n .. code-block:: python\n \n @app.route('/api/users/')\n def users():\n all_users = User.all()\n result = users_schema.dump(all_users)\n return jsonify(result.data)\n # OR\n # return user_schema.jsonify(all_users)\n \n @app.route('/api/users/<id>')\n def user_detail(id):\n user = User.get(id)\n return user_schema.jsonify(user)\n # {\n # \"email\": \"fred@queen.com\",\n # \"date_created\": \"Fri, 25 Apr 2014 06:02:56 -0000\",\n # \"_links\": {\n # \"self\": \"/api/users/42\",\n # \"collection\": \"/api/users/\"\n # }\n # }\n \n \n http://flask-marshmallow.readthedocs.io/\n ========================================\n \n Learn More\n ==========\n \n To learn more about marshmallow, check out its `docs <http://marshmallow.readthedocs.io/en/latest/>`_.\n \n \n \n Project Links\n =============\n \n - Docs: https://flask-marshmallow.readthedocs.io/\n - Changelog: http://flask-marshmallow.readthedocs.io/en/latest/changelog.html\n - PyPI: https://pypi.python.org/pypi/flask-marshmallow\n - Issues: https://github.com/marshmallow-code/flask-marshmallow/issues\n \n License\n =======\n \n MIT licensed. See the bundled `LICENSE <https://github.com/marshmallow-code/flask-marshmallow/blob/master/LICENSE>`_ file for more details.\n \n \n .. _Flask: http://flask.pocoo.org\n .. _marshmallow: http://marshmallow.readthedocs.io\n \n .. |pypi-package| image:: https://badge.fury.io/py/flask-marshmallow.svg\n :target: http://badge.fury.io/py/flask-marshmallow\n :alt: Latest version\n .. |build-status| image:: https://travis-ci.org/marshmallow-code/flask-marshmallow.svg?branch=pypi\n :target: https://travis-ci.org/marshmallow-code/flask-marshmallow\n :alt: Travis-CI\n .. |docs| image:: https://readthedocs.org/projects/flask-marshmallow/badge/\n :target: http://flask-marshmallow.readthedocs.io/\n :alt: Documentation\n \nKeywords: flask-marshmallow\nPlatform: UNKNOWN\nClassifier: Development Status :: 4 - Beta\nClassifier: Environment :: Web Environment\nClassifier: Intended Audience :: Developers\nClassifier: License :: OSI Approved :: MIT License\nClassifier: Natural Language :: English\nClassifier: Programming Language :: Python :: 2\nClassifier: Programming Language :: Python :: 2.7\nClassifier: Programming Language :: Python :: 3\nClassifier: Programming Language :: Python :: 3.4\nClassifier: Programming Language :: Python :: 3.5\nClassifier: Programming Language :: Python :: 3.6\nClassifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content\n",
"tox": true,
"lcname": "flask-marshmallow",
"name": "flask-marshmallow",
"github": true,
"coveralls": false,
"bugtrack_url": null,
"license": "Copyright 2014-2017 Steven Loria and contributors",
"travis_ci": true,
"github_project": "flask-marshmallow",
"summary": "Flask + marshmallow for beautiful APIs",
"split_keywords": [],
"author_email": "sloria1@gmail.com",
"urls": [
{
"has_sig": false,
"upload_time": "2018-04-29T12:54:32",
"comment_text": "",
"python_version": "py2.py3",
"url": "https://files.pythonhosted.org/packages/9a/50/6580e216f9cd775760aee62d873abe56fe96cf2e06319948632bf99980ce/flask_marshmallow-0.9.0-py2.py3-none-any.whl",
"md5_digest": "da875c592748dacd97494ea3d006e788",
"downloads": -1,
"filename": "flask_marshmallow-0.9.0-py2.py3-none-any.whl",
"packagetype": "bdist_wheel",
"digests": {
"sha256": "75c9d80f22af982b1e8ccec109d3b75c14bb5570602ae3705a4ff775badd2816",
"md5": "da875c592748dacd97494ea3d006e788"
},
"size": 9051
},
{
"has_sig": false,
"upload_time": "2018-04-29T12:54:33",
"comment_text": "",
"python_version": "source",
"url": "https://files.pythonhosted.org/packages/91/f1/6ae4d3ff96c8c29245ffc2235feb322b323f5cf7c4ed69ce477e6d2aa848/flask-marshmallow-0.9.0.tar.gz",
"md5_digest": "aea2325274a87c11762349c35f981807",
"downloads": -1,
"filename": "flask-marshmallow-0.9.0.tar.gz",
"packagetype": "sdist",
"digests": {
"sha256": "db7aff4130eb99fd05ab78fd2e2c58843ba0f208899aeb1c14aff9cd98ae8c80",
"md5": "aea2325274a87c11762349c35f981807"
},
"size": 29110
}
],
"_id": null
}
JSON
