============
Front Matter
============

Information about the dogpile.core project.

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

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

.. versionchanged:: 0.4.2 Moved source repository to git.

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

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

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

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

    pip install dogpile.core

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

    python setup.py install

Community
=========

dogpile.core is developed by `Mike Bayer <http://techspot.zzzeek.org>`_, and is
loosely associated with the `Pylons Project <http://www.pylonsproject.org/>`_.
As usage of dogpile.core and dogpile.cache 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.core 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.core, 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.core issue tracker <https://bitbucket.org/zzzeek/dogpile.core/issues?status=new&status=open>`_