Skip to main content

Forest connector for Django

Project description

## Install

In settings.py


INSTALLED_APPS = [
...
'forest',
'corsheaders'
...
]


MIDDLEWARE_CLASSES = [
...
'corsheaders.middleware.CorsMiddleware',
...
]

CORS_ORIGIN_ALLOW_ALL = False
CORS_ORIGIN_WHITELIST = ('app.forestadmin.com')
FOREST_APP_NAME = [<module_path>] # Accepts <module_path>.*
FOREST_SECRET_KEY = <forest_secret_key>
JWT_SECRET = <jwt_secret_key>

In your urls router (urls.py)

url(r'^forest/', include('forest.urls')),


## Development

For local development, use:

`python setup.py develop`

## Build

`python setup.py sdist`

## Actions

Create the following structure in your app folder.
E.g. if your app is 'movies':

Create `./movies/forest/actions/__init__.py`

Then put single file action in the actions directory:

Create `./movies/forest/actions/ban_user.py` with the following content:

ACTION = {
'collection': 'Customers',
'name': 'Ban User',
'fields': [
{ 'field': 'duration', 'type': 'Number'}
]
}

The variable name must be `ACTION`.

## Smart Collections

Create the following structure in your app folder.
E.g. if your app is 'movies':

Create `./movies/forest/smart_collections/__init__.py`

Then put single file smart_collection in the `smart_collections` directory:

Create `./movies/forest/smart_collections/brands.py` with the following content:

SMART_COLLECTION = {
'name': 'Brands',
'fields': [
{ 'field': 'brand', 'type': 'String'},
{ 'field': 'count', 'type': 'Number'}
]
}

The variable name must be `SMART_COLLECTION`.

Project details


Release history Release notifications

This version
History Node

0.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
forest-django-0.1.tar.gz (14.6 kB) Copy SHA256 hash SHA256 Source None Sep 9, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page