Installation

This section contains information about how to download and install django-oembed-works 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-oembed-works
Django
sphinx

This information exists in the requirements.txt file inside the django-oembed-works 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-oembed-works 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-oembed-works
hg tags
hg update 0.1.0

Install

To install django-oembed-works, use the provided installation script:

python setup.py install

You can install django-oembed-works using pip:

pip install django-oembed-works

Or use easy_install:

easy_install -Z django-oembed-works

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

Alternatively, you can simply place the oembed_works 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-oembed-works#egg=django-oembed-works

The above command will install the latest development release of django-oembed-works.

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/django-oembed-works@0.1.0#egg=django-oembed-works-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