METADATA 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  1. Metadata-Version: 2.1
  2. Name: marshmallow
  3. Version: 3.0.0rc5
  4. Summary: A lightweight library for converting complex datatypes to and from native Python datatypes.
  5. Home-page: https://github.com/marshmallow-code/marshmallow
  6. Author: Steven Loria
  7. Author-email: sloria1@gmail.com
  8. License: MIT
  9. Project-URL: Changelog, https://marshmallow.readthedocs.io/en/latest/changelog.html
  10. Project-URL: Issues, https://github.com/marshmallow-code/marshmallow/issues
  11. Project-URL: Funding, https://opencollective.com/marshmallow
  12. Project-URL: Tidelift, https://tidelift.com/subscription/pkg/pypi-marshmallow?utm_source=pypi-marshmallow&utm_medium=pypi
  13. Keywords: serialization,rest,json,api,marshal,marshalling,deserialization,validation,schema
  14. Platform: UNKNOWN
  15. Classifier: Development Status :: 5 - Production/Stable
  16. Classifier: Intended Audience :: Developers
  17. Classifier: License :: OSI Approved :: MIT License
  18. Classifier: Programming Language :: Python :: 2
  19. Classifier: Programming Language :: Python :: 2.7
  20. Classifier: Programming Language :: Python :: 3
  21. Classifier: Programming Language :: Python :: 3.5
  22. Classifier: Programming Language :: Python :: 3.6
  23. Classifier: Programming Language :: Python :: 3.7
  24. Provides-Extra: dev
  25. Requires-Dist: python-dateutil (>=2.7.0) ; extra == 'dev'
  26. Requires-Dist: simplejson ; extra == 'dev'
  27. Requires-Dist: pytest ; extra == 'dev'
  28. Requires-Dist: pytz ; extra == 'dev'
  29. Requires-Dist: flake8 (==3.7.7) ; extra == 'dev'
  30. Requires-Dist: pre-commit (==1.14.4) ; extra == 'dev'
  31. Requires-Dist: tox ; extra == 'dev'
  32. Provides-Extra: lint
  33. Requires-Dist: flake8 (==3.7.7) ; extra == 'lint'
  34. Requires-Dist: pre-commit (==1.14.4) ; extra == 'lint'
  35. Provides-Extra: reco
  36. Requires-Dist: python-dateutil (>=2.7.0) ; extra == 'reco'
  37. Requires-Dist: simplejson ; extra == 'reco'
  38. Provides-Extra: tests
  39. Requires-Dist: pytest ; extra == 'tests'
  40. Requires-Dist: pytz ; extra == 'tests'
  41. ********************************************
  42. marshmallow: simplified object serialization
  43. ********************************************
  44. .. image:: https://badgen.net/pypi/v/marshmallow
  45. :target: https://pypi.org/project/marshmallow/
  46. :alt: Latest version
  47. .. image:: https://badgen.net/travis/marshmallow-code/marshmallow/dev
  48. :target: https://travis-ci.org/marshmallow-code/marshmallow
  49. :alt: Travis-CI
  50. .. image:: https://readthedocs.org/projects/marshmallow/badge/
  51. :target: https://marshmallow.readthedocs.io/
  52. :alt: Documentation
  53. **marshmallow** is an ORM/ODM/framework-agnostic library for converting complex datatypes, such as objects, to and from native Python datatypes.
  54. .. code-block:: python
  55. from datetime import date
  56. from marshmallow import Schema, fields, pprint
  57. class ArtistSchema(Schema):
  58. name = fields.Str()
  59. class AlbumSchema(Schema):
  60. title = fields.Str()
  61. release_date = fields.Date()
  62. artist = fields.Nested(ArtistSchema())
  63. bowie = dict(name='David Bowie')
  64. album = dict(artist=bowie, title='Hunky Dory', release_date=date(1971, 12, 17))
  65. schema = AlbumSchema()
  66. result = schema.dump(album)
  67. pprint(result, indent=2)
  68. # { 'artist': {'name': 'David Bowie'},
  69. # 'release_date': '1971-12-17',
  70. # 'title': 'Hunky Dory'}
  71. In short, marshmallow schemas can be used to:
  72. - **Validate** input data.
  73. - **Deserialize** input data to app-level objects.
  74. - **Serialize** app-level objects to primitive Python types. The serialized objects can then be rendered to standard formats such as JSON for use in an HTTP API.
  75. Get It Now
  76. ==========
  77. ::
  78. $ pip install -U marshmallow --pre
  79. Documentation
  80. =============
  81. Full documentation is available at https://marshmallow.readthedocs.io/ .
  82. Requirements
  83. ============
  84. - Python >= 2.7 or >= 3.5
  85. marshmallow has no external dependencies outside of the Python standard library, although `python-dateutil <https://pypi.python.org/pypi/python-dateutil>`_ is recommended for robust datetime deserialization.
  86. Ecosystem
  87. =========
  88. A list of marshmallow-related libraries can be found at the GitHub wiki here:
  89. https://github.com/marshmallow-code/marshmallow/wiki/Ecosystem
  90. Credits
  91. =======
  92. Contributors
  93. ------------
  94. This project exists thanks to all the people who contribute.
  95. You're highly encouraged to participate in marshmallow's development.
  96. Check out the `Contributing Guidelines <https://marshmallow.readthedocs.io/en/latest/contributing.html>`_ to see
  97. how you can help.
  98. Thank you to all who have already contributed to marshmallow!
  99. .. image:: https://opencollective.com/marshmallow/contributors.svg?width=890&button=false
  100. :target: https://marshmallow.readthedocs.io/en/latest/authors.html
  101. :alt: Contributors
  102. Backers
  103. -------
  104. If you find marshmallow useful, please consider supporting the team with
  105. a donation. Your donation helps move marshmallow forward.
  106. Thank you to all our backers! [`Become a backer`_]
  107. .. _`Become a backer`: https://opencollective.com/marshmallow#backer
  108. .. image:: https://opencollective.com/marshmallow/backers.svg?width=890
  109. :target: https://opencollective.com/marshmallow#backers
  110. :alt: Backers
  111. Sponsors
  112. --------
  113. Support this project by becoming a sponsor (or ask your company to support this project by becoming a sponsor).
  114. Your logo will show up here with a link to your website. [`Become a sponsor`_]
  115. .. _`Become a sponsor`: https://opencollective.com/marshmallow#sponsor
  116. .. image:: https://opencollective.com/marshmallow/sponsor/0/avatar.svg
  117. :target: https://opencollective.com/marshmallow/sponsor/0/website
  118. :alt: Sponsors
  119. .. image:: https://opencollective.com/static/images/become_sponsor.svg
  120. :target: https://opencollective.com/marshmallow#sponsor
  121. :alt: Become a sponsor
  122. Professional Support
  123. ====================
  124. Professionally-supported marshmallow is now available through the
  125. `Tidelift Subscription <https://tidelift.com/subscription/pkg/pypi-marshmallow?utm_source=pypi-marshmallow&utm_medium=readme>`_.
  126. Tidelift gives software development teams a single source for purchasing and maintaining their software,
  127. with professional-grade assurances from the experts who know it best,
  128. while seamlessly integrating with existing tools. [`Get professional support`_]
  129. .. _`Get professional support`: https://tidelift.com/subscription/pkg/pypi-marshmallow?utm_source=marshmallow&utm_medium=referral&utm_campaign=github
  130. .. image:: https://user-images.githubusercontent.com/2379650/45126032-50b69880-b13f-11e8-9c2c-abd16c433495.png
  131. :target: https://tidelift.com/subscription/pkg/pypi-marshmallow?utm_source=pypi-marshmallow&utm_medium=readme
  132. :alt: Get supported marshmallow with Tidelift
  133. Security Contact Information
  134. ============================
  135. To report a security vulnerability, please use the
  136. `Tidelift security contact <https://tidelift.com/security>`_.
  137. Tidelift will coordinate the fix and disclosure.
  138. Project Links
  139. =============
  140. - Docs: https://marshmallow.readthedocs.io/
  141. - Changelog: https://marshmallow.readthedocs.io/en/latest/changelog.html
  142. - PyPI: https://pypi.python.org/pypi/marshmallow
  143. - Issues: https://github.com/marshmallow-code/marshmallow/issues
  144. - Donate: https://opencollective.com/marshmallow
  145. License
  146. =======
  147. MIT licensed. See the bundled `LICENSE <https://github.com/marshmallow-code/marshmallow/blob/dev/LICENSE>`_ file for more details.