Installation — Django-primary-slug V0.1.1b1 Documentation

Navigation

• index
• next |
• previous |
• django-primary-slug v0.1.1b1 documentation »

Installation¶

This section contains information about how to download and install django-primary-slug in your system. It also contains brief instructions about how to build the included documentation.

Requirements¶

This application requires Python 2.4 or later and a functional installation of Django.

Detailed information about the minimum supported Django version and other Python modules that may be required in order to run this software is shown below:

django-primary-slug Django Sphinx

This information exists in the requirements.txt file inside the django-primary-slug distribution package. If pip is used to install this software, then all these dependencies will also be installed, if they are not already installed in your system.

Download¶

You can download the latest django-primary-slug releases from the releases page at the Python Package Index (PyPI).

Alternatively, you can clone the project’s public source code repository and then check-out any stable release, all of which are tagged:

hg clone https://source.codetrax.org/hgroot/django-primary-slug hg tags hg update 0.1.0

Install¶

To install django-primary-slug, use the provided installation script:

python setup.py install

You can install django-primary-slug using pip:

pip install django-primary-slug

Or use easy_install:

easy_install -Z django-primary-slug

Note: the -Z flag is required to force easy_install to do a normal source install rather than a zipped egg; django-primary-slug cannot be used from a zipped egg install.

Alternatively, you can simply place the primary_slug directory, which exists under the src directory, somewhere on your Python path or symlink to it from somewhere on your Python path.

Finally, it is also possible to install this application directly from the source code repository using pip:

pip install -e hg+https://source.codetrax.org/hgroot/django-primary-slug#egg=django-primary-slug

The above command will install the latest development release of django-primary-slug.

To install a stable release directly from the source code repository, for instance, the 0.1.0 release, run the following command:

pip install -e hg+https://source.codetrax.org/hgroot/[email protected]#egg=django-primary-slug-0.1.0

Please note that the mercurial source control management tool is required for this operation.

How to build the documentation¶

This project’s documentation is located in source form under the docs directory. In order to convert the documentation to a format that is easy to read and navigate you need the sphinx package.

You can install sphinx using pip:

pip install sphinx

Or easy_install:

easy_install sphinx

Once sphinx is installed, change to the docs directory, open a shell and run the following command:

make html

This will build a HTML version of the documentation. You can read the documentation by opening the following file in any web browser:

docs/_build/html/index.html

Table Of Contents

• Installation
  • Requirements
  • Download
  • Install
  • How to build the documentation

Previous topic

Introduction

Next topic

Configuration

This Page

• Show Source

Quick search

Enter search terms or a module, class or function name.

Navigation

• index
• next |
• previous |
• django-primary-slug v0.1.1b1 documentation »

© Copyright 2011, George Notaras. Created using Sphinx 1.0.7.