index.rst

pycassa |release| Documentation

Contents

pycassa is a Python client for Apache Cassandra.

:doc:`installation`

How to install pycassa.

:doc:`tutorial`

A short overview of pycassa usage.

:doc:`example/index`

An example of how to use pycassa with Twissandra, an example project that uses Cassandra to provide functionality similar to Twitter.

:doc:`pycassa_shell`

How to use the included pycassaShell.

:doc:`api/index`

The pycassa API documentation.

Help

Mailing Lists

• User list: mail to pycassa-discuss@googlegroups.com or view online.
• Developer list: mail to pycassa-devel@googlegroups.com or view online.

IRC

• Use #cassandra on irc.freenode.net. If you don't have an IRC client, you can use freenode's web based client.

Issues

Bugs and feature requests for pycassa are currently tracked through the github issue tracker.

Contributing

pycassa encourages you to offer any contributions or ideas you have. Contributing to the documentation or examples, reporting bugs, requesting features, and (of course) improving the code are all equally welcome. To contribute, fork the project on github and make a pull request.

Changes

The :doc:`changelog` lists the changes between versions of pycassa.

About This Documentation

This documentation is generated using the Sphinx documentation generator. The source files for the documentation are located in the doc/ directory of pycassa. To generate the documentation, run the following command from the root directory of pycassa:

$ python setup.py doc

Indices and tables

• :ref:`genindex`
• :ref:`modindex`
• :ref:`search`

.. toctree::
   :hidden:

   installation
   tutorial
   pycassa_shell
   example/index
   api/index
   changelog