https://github.com/colinhiggs/pyramid-jsonapi

Auto-build JSON API from sqlalchemy models using the pyramid framework
https://github.com/colinhiggs/pyramid-jsonapi

Last synced: about 2 months ago
JSON representation

Auto-build JSON API from sqlalchemy models using the pyramid framework

• Host: GitHub
• URL: https://github.com/colinhiggs/pyramid-jsonapi
• Owner: colinhiggs
• License: agpl-3.0
• Created: 2015-07-21T12:58:20.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-10-05T14:45:17.000Z (over 1 year ago)
• Last Synced: 2024-04-23T12:39:03.864Z (9 months ago)
• Language: Python
• Homepage:
• Size: 9.3 MB
• Stars: 26
• Watchers: 5
• Forks: 15
• Open Issues: 13
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-pyramid - pyramid_jsonapi - Automatically (RESTful API)

README

        
The pyramid-jsonapi project

===========================

.. image:: https://img.shields.io/pypi/v/pyramid_jsonapi.svg

  :target: https://pypi.python.org/pypi/pyramid_jsonapi

.. image:: https://img.shields.io/pypi/pyversions/pyramid_jsonapi.svg

.. image:: https://travis-ci.org/colinhiggs/pyramid-jsonapi.svg?branch=master

  :target: https://travis-ci.org/colinhiggs/pyramid-jsonapi

.. image:: https://coveralls.io/repos/github/colinhiggs/pyramid-jsonapi/badge.svg?branch=master

  :target: https://coveralls.io/github/colinhiggs/pyramid-jsonapi?branch=master

.. image:: https://colinhiggs.github.io/pyramid-jsonapi/pylint-badge.svg

Create a JSON-API (``_) standard API from a database using

the sqlAlchemy ORM and pyramid framework.

The core idea behind pyramid-jsonapi is to create a working JSON-API

automatically, starting from the sort of ``models.py`` file shipped with a

typical pyramid + sqlalchemy application.

.. note::

  The default branch of pyramid_jsonapi is now the 2.2 branch.

Documentation

-------------

Documentation is available at: ``_

Quick start

===========

Installing `pyramid_jsonapi`

----------------------------

.. code-block:: bash

  pip install -i pyramid_jsonapi

See :ref:`getting-started` for other installation options, including installing

development versions.

Auto-Creating an API

--------------------

Declare your models somewhere using sqlalchemy's

:func:`sqlalchemy.ext.declarative.declarative_base`. In this documentation we

assume that you have done so in a file called ``models.py``:

.. code-block:: python

  class Person(Base):

      __tablename__ = 'people'

      id = Column(BigInteger, primary_key=True, autoincrement=True)

      name = Column(Text)

      blogs = relationship('Blog', backref='owner')

      posts = relationship('Post', backref='author')

  # and the rest...

If you are happy with the defaults, you can get away with the following

additions to the standard pyramid alchemy scaffold's top level ``__init__.py``:

.. code-block:: python

  import pyramid_jsonapi

  from . import models # Your models module.

  def main(global_config, **settings):

    # The usual stuff from the pyramid alchemy setup.

    config = Configurator(settings=settings)

    # pyramid_jsonapi uses the renderer labelled 'json'. As usual, if you have

    # any types to serialise that the default JSON renderer can't handle, you

    # must alter it. For example:

    #

    #renderer = JSON(sort_keys=True)

    #renderer.add_adapter(datetime.date, datetime_adapter)

    #config.add_renderer('json', renderer)

    # Instantiate a PyramidJSONAPI class instance.

    pj = pyramid_jsonapi.PyramidJSONAPI(config, models)

    # If you are using pyramid 1.7 or older, you will need to pass a third

    # argument to the constructor: a callable which accepts a CollectionView

    # instance as an argument and returns a sqlalchemy database session.

    #

    # For example:

    # pj = pyramid_jsonapi.PyramidJSONAPI(

    #   config, models, lambda view: models.DBSession

    # )

    # Create the routes and views automagically:

    pj.create_jsonapi_using_magic_and_pixie_dust()

    # Routes and views are added imperatively, so no need for a scan - unless

    # you have defined other routes and views declaratively.

    return config.make_wsgi_app()

Or, without all the comments:

.. code-block:: python

  import pyramid_jsonapi

  from . import models

  def main(global_config, **settings):

    config = Configurator(settings=settings)

    pj = pyramid_jsonapi.PyramidJSONAPI(config, models)

    pj.create_jsonapi_using_magic_and_pixie_dust()

    return config.make_wsgi_app()

Yes, there really is a method called

:func:`pyramid_jsonapi.PyramidJSONAPI.create_jsonapi_using_magic_and_pixie_dust`. No, you

don't *have* to call it that. If you are feeling more sensible you can use the

synonym :func:`pyramid_jsonapi.PyramidJSONAPI.create_jsonapi`.