<commit_before>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 (`<http://jsonapi.org/>`_) 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.


Documentation
-------------

Documentation is available at: `<https://colinhiggs.github.io/pyramid-jsonapi/>`_

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
<commit_msg>Notify of upcoming changes<commit_after>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 (`<http://jsonapi.org/>`_) 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::

  Most work has shifted to an upcoming new version. The ``2_2_master`` is where
  the development is happening, although the resulting release is likely to be
  named "3" rather than "2" due to the number of breaking changes. More
  information soon. 

Documentation
-------------

Documentation is available at: `<https://colinhiggs.github.io/pyramid-jsonapi/>`_

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

{'fraction_non_alphanumeric': 0.16608594657375145, 'fraction_numerical': 0.0011614401858304297, 'mean_word_length': 3.914407988587732, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 18, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '554053', 'n_tokens_mistral': 1138, 'n_tokens_neox': 1062, 'n_words': 272}