summaryrefslogtreecommitdiff
path: root/docs/build/front.rst
blob: af5a1df13c0824cc2dd34778629d2d4b3d9c09dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
============
Front Matter
============

Information about the Dogpile project.

Project Homepage
================

Dogpile is hosted on `Bitbucket <http://bitbucket.org>`_ - the lead project page is at https://bitbucket.org/zzzeek/dogpile.  Source
code is tracked here using `Mercurial <http://mercurial.selenic.com/>`_.

Releases and project status are available on Pypi at http://pypi.python.org/pypi/dogpile.

The most recent published version of this documentation should be at http://readthedocs.org/docs/dogpile/.

Installation
============

Install released versions of Dogpile from the Python package index with `pip <http://pypi.python.org/pypi/pip>`_ or a similar tool::

    pip install dogpile

Installation via source distribution is via the ``setup.py`` script::

    python setup.py install

Community
=========

Dogpile is developed by `Mike Bayer <http://techspot.zzzeek.org>`_, and is 
loosely associated with the `Pylons Project <http://www.pylonsproject.org/>`_.
As Dogpile's usage increases, it is anticipated that the Pylons mailing list and IRC channel
will become the primary channels for support.

Bugs
====
Bugs and feature enhancements to Dogpile should be reported on the `Bitbucket
issue tracker
<https://bitbucket.org/zzzeek/dogpile/issues?status=new&status=open>`_.  If you're not sure 
that a particular issue is specific to either dogpile.cache or Dogpile, posting to the `dogpile.cache issue tracker <https://bitbucket.org/zzzeek/dogpile.cache/issues?status=new&status=open>`_
is likely the better place to post first, but it's not critical either way.

* `dogpile.cache issue tracker <https://bitbucket.org/zzzeek/dogpile.cache/issues?status=new&status=open>`_ (post here if unsure)
* `dogpile issue tracker <https://bitbucket.org/zzzeek/dogpile/issues?status=new&status=open>`_