Skip to main content

A RESTful JSON API for django-fiction-outlines. Part of the broader maceoutliner project.

Project description Documenatation Status

A RESTful JSON API for django-fiction-outlines.


The full documentation is at The source code can be found at


Install Django Fiction Outlines API:

pip install django-fiction-outlines-api

Add it and dependencies to your INSTALLED_APPS:


If you have not already, add rules to you AUTHENTICATION_BACKENDS.


Unless you like to live dangerously, it is STRONGLY recommend you configure whichever database you use for outlines to have ATOMIC_REQUESTS to True.

    "default": {
        "ENGINE": "django.db.backends.postgresql",
        "NAME": "outlines",
        "ATOMIC_REQUESTS": True,

Add Django Fiction Outlines API’s URL patterns:

from fiction_outlines_api import urls as fiction_outlines_api_urls

urlpatterns = [
    url(r'^', include(fiction_outlines_api_urls)),

If you haven’t already installed fiction_outlines you should run python migrate now.


NOTE: As with fiction_outlines, this app makes use of the excellent object permissions library django-rules.

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install -r test_requirements.txt
(myenv) $ pytest
(myenv) $ flake8 fiction_outlines_api tests


Tools used in rendering this package:


0.1.0 (2018-04-07)

  • First release on PyPI.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-fiction-outlines-api, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size django-fiction-outlines-api-0.1.2.tar.gz (16.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page