Metadata-Version: 1.0
Name: core_main_registry_app
Version: 1.12.0
Summary: Main functionalities for the registry project
Home-page: https://github.com/usnistgov/core_main_registry_app
Author: NIST IT Lab
Author-email: itl_inquiries@nist.gov
License: UNKNOWN
Description: Core Main Registry App
        ======================
        
        This Django reusable app contains the main functionalities for the registry core project.
        
        Pre-requisites
        ==============
        
        * Install git
        * Install python
        * Install pip
        * Create a virtual env
        
        Installation
        ============
        
        Automated installation
        ----------------------
        
        .. warning::
        
            *The automated installation is not yet available.*
        
        Manual installation
        -------------------
        
        .. code:: bash
        
            $ git clone https://myrepo.com/core_main_registry_app.git
            $ cd core_main_registry_app
            $ python setup.py
            $ pip install sdist/*.tar.gz
        
        
        Configuration
        =============
        
        1. Add "core_main_registry_app", "mptt", "tz_detect" to your INSTALLED_APPS setting like this
        ---------------------------------------------------------------------------------------------
        
        .. code:: python
        
            INSTALLED_APPS = [
                ...
                "tz_detect",
                "core_main_registry_app",
                "mptt",
            ]
        
        2. Add the middleware required by tz_detect
        -------------------------------------------
        
        .. code:: python
        
            MIDDLEWARE = (
                ...
                'tz_detect.middleware.TimezoneMiddleware',
            )
        
        
        3. Include the core_main_registry_app URLconf in your project urls.py like this
        -------------------------------------------------------------------------------
        
        .. code:: python
        
            url(r'^', include("core_main_registry_app.urls")),
        
        
        4. Launch migration: create table and constraints.
        --------------------------------------------------
        
            $ python manage.py migrate
        
Platform: UNKNOWN
