Changeset - 14e47a3b0ea2
[Not reviewed]
default
0 2 0
Branko Majic (branko) - 11 years ago 2013-06-30 20:50:56
branko@majic.rs
Fixed the repository link in docs. Added a warning about failure in case of buggy pip version.
2 files changed with 22 insertions and 5 deletions:
0 comments (0 inline, 0 general)
docs/installation.rst
Show inline comments
 
@@ -3,30 +3,41 @@ Installation
 

	
 
Django Conntrackt can be installed through one of the following methods:
 

	
 
* Using *pip*, which is the recommended way for production
 
  websites.
 

	
 

	
 
Using pip
 
---------
 

	
 
In order to install latest stable release of Django Conntrackt using *pip*, use
 
the following command::
 

	
 
  pip install conntrackt
 

	
 
In order to install the latest development version of Django Conntrackt from
 
Mercurial repository, use the following command::
 

	
 
 pip install -e hg+https://hg.majic.rs/conntrackt#egg=conntrackt
 
 pip install -e hg+http://code.majic.rs/conntrackt#egg=conntrackt
 

	
 
.. warning::
 

	
 
   You will need to update the ``pip`` installation in your virtual environment if you get the following error while running the above command::
 

	
 
     AttributeError: 'NoneType' object has no attribute 'skip_requirements_regex'
 

	
 
   You can update ``pip`` to latest version with::
 

	
 
     pip install -U pip
 

	
 
After this you should proceed to :ref:`configure your Django installation <configuring-django>`.
 

	
 

	
 
.. _configuring-django:
 

	
 
Configuring your Django installation
 
====================================
 

	
 
Once the Django Conntrackt has been installed, you need to perform the following
 
steps in order to make it available inside of your Django project:
 

	
docs/quickstart.rst
Show inline comments
 
@@ -10,33 +10,39 @@ Debian/Ubuntu
 
Install the *pip* utility::
 

	
 
  sudo apt-get install pip
 

	
 
Install the *virtualenv* and *virtualenvwrapper*::
 

	
 
  sudo apt-get install python-virtualenv virtualenvwrapper
 

	
 
Create the virtual environment for testing Django Conntrackt::
 

	
 
  mkvirtualenv conntrackt
 

	
 
Install the latest version of pip (that contains fix for parsing the requirement files)::
 

	
 
  pip install -U pip
 

	
 
Install Django Conntrackt with its requirements::
 

	
 
  workon conntrackt
 
  pip install -e hg+http://code.majic.rs/conntrackt#egg=conntrackt
 

	
 
.. warning::
 

	
 
   You will need to update the ``pip`` installation in your virtual environment if you get the following error while running the above command::
 

	
 
     AttributeError: 'NoneType' object has no attribute 'skip_requirements_regex'
 

	
 
   You can update ``pip`` to latest version with::
 

	
 
     pip install -U pip
 

	
 
Start a new Django Conntrackt project::
 

	
 
  django-admin.py startproject conntrackt_test
 

	
 
Edit configuration file ``conntrackt_test/conntrackt_test/settings.py`` to set-up
 
some basic settings:
 

	
 
#. Under ``DATABASES`` set parameter ``ENGINE`` to ``'django.db.backends.sqlite3'``.
 
#. Under ``DATABASES`` set parameter ``NAME`` to ``'conntrackt_test.sqlite'``.
 
#. Under ``INSTALLED_APPS`` uncomment the line ``'django.contrib.admin'``.
 
#. Under ``INSTALLED_APPS`` append lines::
 

	
0 comments (0 inline, 0 general)