django-spotnet 0.1 documentation¶

Automatic installation via a package manager¶

Several automatic package-installation tools are available for Python; the most popular are easy_install and pip. Either can be used to install django-spotnet.

Using easy_install, type:

easy_install -Z django-spotnet

Note that the -Z flag is required, to tell easy_install not to create a zipped package; zipped packages prevent certain features of Django from working properly.

Using pip, type:

pip install django-spotnet

It is also possible that your operating system distributor provides a packaged version of django-spotnet. Consult your operating system’s package list for details, but be aware that third-party distributions may be providing older versions of django-spotnet, and so you should consult the documentation which comes with your operating system’s package.

Manual installation from a downloaded package¶

If you prefer not to use an automated package installer, you can download a copy of django-spotnet and install it manually. The latest release package can be downloaded from django-spotnet’s listing on the Python Package Index.

Once you’ve downloaded the package, unpack it (on most operating systems, simply double-click; alternately, type tar zxvf django-spotnet-0.1.tar.gz at a command line on Linux, Mac OS X or other Unix-like systems). This will create the directory django-spotnet-0.1, which contains the setup.py installation script. From a command line in that directory, type:

python setup.py install

Note that on some systems you may need to execute this with administrative privileges (e.g., sudo python setup.py install).

Manual installation from a Mercurial checkout¶

If you’d like to try out the latest in-development code, you can obtain it from the django-spotnet repository, which is hosted at Bitbucket and uses Mercurial for version control. To obtain the latest code and documentation, you’ll need to have Mercurial installed, at which point you can type:

hg clone http://bitbucket.org/Blue/django-spotnet

You can also obtain a copy of a particular release of django-spotnet by specifying the -r argument to hg clone; each release is given a tag of the form vX.Y, where “X.Y” is the release number. So, for example, to check out a copy of the 0.1 release, type:

hg clone -r v0.1 http://bitbucket.org/Blue/django-spotnet

In either case, this will create a copy of the django-spotnet Mercurial repository on your computer; you can then add the django-spotnet directory inside the checkout your Python import path, or use the setup.py script to install as a package.

Setting up URLs¶

The app includes a Django URLconf which sets up URL patterns for the views in django-spotnet. This URLconf can be found at spotnet.urls, and so can simply be included in your project’s root URL configuration. For example, to place the URLs under the prefix /spotnet/, you could add the following to your project’s root URLconf:

(r'^spotnet/', include('spotnet.urls')),

This would then be the index page for using spotnet. To completely customize the url locations, add the urlpatterns for the included views yourself. If you go down this road, do make sure to use the same url names as the default urlconf.

Templates¶

By default, spotnet uses very simple templates for it’s views. You probably want to override these by creating your own templates. These should be findable under names like spotnet/list.html. See the included templates and their views for the names and available context variables.

Note that all of these templates are rendered using a RequestContext and so will receive any additional variables provided by context processors.