Metadata-Version: 1.1
Name: forest-django
Version: 0.1
Summary: Forest connector for Django
Home-page: https://www.forestadmin.com/
Author: Raphael De Giusti
Author-email: raphael.degiusti@gmail.com
License: GNU License
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`.
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.7
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
