1. User Guide

This section of the documentation provides user focused information such as installing and quickly using this package.

1.1. Install Guide

Note

It is best practice to install Python projects in a virtual environment, which can be created and activated as follows using Python 3.6+.

$ python -m venv venv --prompt myvenv
$ source venv/bin/activate
(myvenv) $

The simplest way to install django-odm2 is using Pip.

$ pip install django-odm2

This will install django-odm2 and all of its dependencies.

1.2. API Reference

The API Reference provides API-level documentation.

1.3. Change Log

1.3.1. Version History

0.0.2

  • Fixed typo in initial migration

0.0.1

  • Project created.

1.4. Report Bugs

Report bugs at the issue tracker.

Please include:

  • Operating system name and version.

  • Any details about your local setup that might be helpful in troubleshooting.

  • Detailed steps to reproduce the bug.