Metadata-Version: 1.0
Name: django-elasticmodels
Version: 1.0
Summary: A tool to map Django models to ElasticSearch mappings
Home-page: https://bitbucket.com/jvennik/django-elasticmodels
Author: Jos Vennik
Author-email: josvennik@gmail.com
License:    Copyright 2011-2013 Jos Vennik <josvennik@gmail.com>

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

Description: ========
         README
        ========
        
        django-elasticmodels is a convenient tool to map your Django models to
        ElasticSearch mappings.
        
        Project details
        ===============
        
        :Code:           https://bitbucket.org/jvennik/django-elasticmodels
        :Documentation:  #
        :Issue tracker:  https://bitbucket.org/jvennik/django-elasticmodels/issues
        :License:        BSD 3-clause; see LICENSE file
        
        
        Quick install
        =============
        
        Latest released version::
        
            $ pip install django-elasticmodels
        
        Usage
        =============
        
        To use django-elasticmodels in your Django project:
        
            1. Add ``'elasticmodels'`` to your ``INSTALLED APPS`` setting.
            2. Add ``'ELASTICSEARCH_HOST'`` (string)
            3. Add ``'ELASTICSEARCH_MODELS'`` (list) >> ``'["yourapp.yourmodel",]'`` to your settings file
            4. [Optional] Add ``'ELASTICSEARCH_CUSTOM_TYPES'`` (dict) to your settings file if you want to specify a specific field type yourself >> Example: ``'"geo_location": {"type": "geo_point"}'``
            5. [Optional] Add ``'ELASTICSEARCH_NON_MODEL_FIELDS'`` (list). Here you can add fields that are not present on your model >> Example: ``'{"snippet": {"type": "string"}}'``
            6. Run ./manage.py create_indexes
        
        Examples will be added at a later date.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Natural Language :: English
