A Django project template for Mongo Engine. Following is the setup instruction for local setup.
NOTE: Though Mongo is the primary datastore, the project still uses SQL for some features: Session Management, Celery, etc. However, these can be completely overridden.
Following is the tech stack being used for main project:
- [Django 1.8] - The core Web Framework
- [Django Rest Framework 3.3.3] - For creating REST APIs
- [Any SQL Database] - As datastore
- [MongoDB 3.0] - As datastore
- [MongoEngine 0.10] - To let Django talk to MongoDB
- [Celery 3.1.23] - A task queue used for async processes and task scheduling
- [Redis 2.8.4] - As message broker, a result backend for Celery and for caching
- [Elastic Search] with [Haystack] for indexing data
- Update ubuntu
sudo apt-get update- Install python-pip
sudo apt-get install python-pip python-dev git
sudo apt-get install build-essential libssl-dev libffi-dev- Install virtualenv and virtualenvwrapper:
sudo pip install virtualenv virtualenvwrapper
sudo pip install --upgrade pip- Create a backup of the .bashrc file
cp ~/.bashrc ~/.bashrc-org- Create a directory to store all the virtual environments
mkdir ~/.virtualenvs- Set WORKON_HOME to virtual environments directory
export WORKON_HOME=~/.virtualenvs- Open bashrc file
sudo nano ~/.bashrc- Add the following line at the end of bashrc file:
. /usr/local/bin/virtualenvwrapper.sh
- Re-source terminal using the following command
source ~/.bashrc- Create new virtual environment
mkvirtualenv project_mongo- Activate the virtual environment
workon project_mongo- Create a parent folder called sites
mkdir sites && cd sites- Clone the project
git clone https://github.com/eshandas/django_project_template_mongo.git- Rename project directory for consistency and cd
mv django_project_template_mongo/ project_mongo && cd project_mongoNOTE: Install the following dependencies before installing Pillow:
sudo apt-get install libjpeg-dev libfreetype6-dev zlib1g-dev- Create a virtual env
mkvirtualenv project_mongo- Point the local settings file in the virtualenv postactivate hook
deactivate
sudo nano ~/.virtualenvs/project_mongo/bin/postactivate- Add the following line
...
export DJANGO_SETTINGS_MODULE=main.settings.local
- Remove the pointer once the env is deactivated
sudo nano ~/.virtualenvs/project_mongo/bin/postdeactivate- Add the following line
...
unset DJANGO_SETTINGS_MODULE
- Reactivate the virtual env
deactivate project_mongo
workon project_mongo- Install all the requirements
pip install -r requirements/local.txt- Run migrations
python manage.py migrate- Test by running
python manage.py runserverNot required for now. Check _docs in case needed.
Not required for now. Check _docs in case needed.
Not required for now. Check _docs in case needed.
Not required for now. Check _docs in case needed.
Not required for now. Check _docs in case needed.
- All the common settings live in main/settings/base.py
- Environment specific settings live in main/settings folder. For e.g., for dev env, we have dev.py. Each setting file has a corresponding wsgi file in main/wsgis folder. The wsgi file points to the corresponding settings file.
Static files are configured to live in site_static/
There are two requirement files: For local, install from requirements/local.txt. For any other hosted environment, install from requirements/server.txt
The project uses Sphinx for documentation. It can automatically create documentation from Doc Strings.
The project also uses Django Rest Swagger for API documentation. It picks up documentation from Doc Strings as well.
- Add doc string in init.py files
- Document your APIs by adding doc strings in API classes
- Add help_text in models. This will be automatically picked up by Sphinx and will be documented.
The project uses Mongomock and for mongo related unit tests and Django Rest Framework for API unit tests.
Use Sublime 3 for writing Python/Django code.
Install it from: http://docs.sublimetext.info/en/latest/getting_started/install.html
Follow this tutorial to configure Sublime for Python and Django: https://realpython.com/blog/python/setting-up-sublime-text-3-for-full-stack-python-development/