Metadata-Version: 2.0
Name: django-usda-mongo
Version: 0.1.1
Summary: Import and map the USDA National Nutrient Database for Standard Reference (SR22) to Django models using MongoDB with mongoengine
Home-page: https://github.com/javipalanca/django-usda-mongo
Author: Javi Palanca
Author-email: jpalanca@codemaniacs.com
License: BSD
Keywords: django-usda-mongo
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3

=============================
django-usda-mongo
=============================

.. image:: https://badge.fury.io/py/django-usda-mongo.png
    :target: https://badge.fury.io/py/django-usda-mongo

.. image:: https://travis-ci.org/javipalanca/django-usda-mongo.png?branch=master
    :target: https://travis-ci.org/javipalanca/django-usda-mongo

.. image:: https://coveralls.io/repos/javipalanca/django-usda-mongo/badge.png?branch=master
    :target: https://coveralls.io/r/javipalanca/django-usda-mongo?branch=master

Overview
--------
django-usda-mongo imports and maps the USDA National Nutrient Database for Standard Reference (SR22) to Django models using MongoDB with mongoengine.
It also integrate django-mongonaut to admin the MongoDB database.


Requirements
------------
* Python 2.5.x
* Django 1.2.x (import_sr22 will not work with early versions)
* mongoengine
* django-mongonaut

Installation
------------
#. pip install django-usda-mongo or copy the `usda_mongo` folder to a location available on your `PYTHONPATH`.
#. Add 'usda' to `INSTALLED_APPS` in `settings.py`
#. Optionally, add `(r'^usda/', include('usda.urls')),` to your `urlpatterns`.

Data Import
-----------
To import the latest SR22 data.  Simply use the `import_sr22` management command
as follows:

    ./manage.py import_sr22

The above assumes that the `sr22.zip` file is in the current folder.  To specify
an alternative location specify `-f <filename>`.

The `import_sr22` command takes several options:

* --database <dbname> -- Specify an alternative database to populate.
* --food -- Create/update all foods.
* --group -- Create/Update food groups.
* --nutrient -- Create/Update nutrients.
* --weight -- Create/Update weights.
* --footnote -- Create/Update footnotes.
* --datasource -- Create/Update data sources.
* --derivation -- Create/Update data derivations.
* --source -- Create/Update sources.
* --data -- Create/Update nutrient data.'
* --all -- Create/Update all data.

All of the above options can be combined to only create/update the desired
data.  If no options are specified, `-all` is assumed.

Also note that all data is loaded in a single transaction to ensure that
database consistency is maintained.

Notes
-----
The USDA National Nutrient Database for Standard Reference (SR22) can be found
here: `http://www.ars.usda.gov/Services/docs.htm?docid=18879 <http://www.ars.usda.gov/Services/docs.htm?docid=18879>`_.



History
-------

0.1.0 (2015-03-31)
++++++++++++++++++

* First release on PyPI.


