djangocms-rest-view

An application to load django CMS pages in a client application.

djangocms-rest-view uses Django REST framework to serve django CMS pages through a REST API

Editing must still be done the “traditional” way

Installation

pip install djangocms-rest-view

Edit INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    'rest_framework',
    'djangocms_rest_view',
    ...
]

Edit urls.py:

urlpatterns = [
    ...
    url(r'^api/', include('djangocms_rest_view.urls')),
    ...
]

That’s all!

The REST view of the pages will be available at http://example.com/api/

Sample client

A sample Angular JS client is provided within the project.

To start exploring djangocms-rest view, you can install it and browse the website:

Edit INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    'djangocms_rest_view.client',
    ...
]

Edit urls.py:

urlpatterns = [
    ...
    url(r'^rest/', include('djangocms_rest_view.client.urls')),
    ...
]

the Angular client will be available at http://example.com/rest/

Install dependencies according to the application bower.json: https://gitix.iast.it/opensource/djangocms-rest-view/blob/master/bower.json

example:

Copy dependencies in project bower.json
run bower:
```
bower install
```

Customize

The sample client uses a dedicated base page to load all the default styles etc needed to render your content. Template is in rest/base.html copy it from djangocms_rest_view/client/templates/rest/base.html and edit it according your needs.

Templates

Each django CMS has a defined template to render.

You can customize the template the AngularJS client will use to render the page:

create a partial directory in the static directory
create html files for each page template
define the content of the rest-page template to render the placeholders and page title:
```
<article class="body">
  <h2 ng-bind="content_page.title"></h2>
  <p ng-bind-html="content_page.placeholders.content | safe"></p>
</article>
```
content_page is the page serialization in the angular scope and contains the full serialization as visible at http://example.com/api/pages/<page-id>; thus content_page.placeholders.content contains the rendered HTML for the content placeholder.

Credits

Tools used in rendering this package:

History

0.1.9 (2016-09-25)

Fixed compatibility with django CMS 3.4

0.1.8 (2016-09-10)

First public “#PyConUK” release

0.1.0 (2016-02-01)

Internal release

Release files for djangocms-rest-view 0.1.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for djangocms-rest-view 0.1.9
File	Size	Uploaded
djangocms-rest-view-0.1.9.tar.gz	14.8 kB	Sep 25, 2016	Details

Built distribution (wheel)

Table of built distributions (wheels) for djangocms-rest-view 0.1.9
File	Interpreter	ABI	Platform	Reset
djangocms_rest_view-0.1.9-py2.py3-none-any.whl 18.5 kB Sep 25, 2016	Python 3, Python 2	none	any	Details

Total release size: 33.3 kB

Release files / djangocms-rest-view-0.1.9.tar.gz

Download URL	djangocms-rest-view-0.1.9.tar.gz
Size	14.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`53b64c1601050b3eba7a34709a0c0b1e6c55c1b594c8aa4492b72d84e873fcbd`
BLAKE2b-256 checksum How to use checksums	`4d596556ce8d81a48e4480a779edae36e5a88b4c8b66350c70621a138fa2146a`
Upload date	Sep 25, 2016
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / djangocms_rest_view-0.1.9-py2.py3-none-any.whl

Download URL	djangocms_rest_view-0.1.9-py2.py3-none-any.whl
Size	18.5 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`08088ee987ff2d2816c30611a24ffdbd756bd825861abcc416b11168eed0592b`
BLAKE2b-256 checksum How to use checksums	`73e5db9205f03db43a5058fef4faacfed2fda5251eb726d8ddda7b1dd1395fb0`
Upload date	Sep 25, 2016
Uploaded using Trusted Publishing? What is trusted publishing?	No