===========================================================
mailman.client - Python bindings for the Mailman 3 REST API
===========================================================

This package is called ``mailman.client``. 


Requirements
============

``mailman.client`` requires Python 2.6 or newer, and is compatible with Python
3 when used with ``2to3``.


Documentation
=============

A `simple guide`_ to using the library is available within this package, in
the form of doctests.   The manual is also available online in the Cheeseshop
at:

    http://package.python.org/mailman.client


Project details
===============

The project home page is:

    http://launchpad.net/mailman.client

You should report bugs at:

    http://bugs.launchpad.net/mailman.client

You can download the latest version of the package either from the Cheeseshop:

    http://pypi.python.org/pypi/mailman.client

or from the Launchpad page above.  Of course you can also just install it with
``pip`` or ``easy_install`` from the command line::

    % sudo pip mailman.client
    % sudo easy_install mailman.client

You can grab the latest development copy of the code using Bazaar, from the
Launchpad home page above.  See http://bazaar-vcs.org for details on the
Bazaar distributed revision control system.  If you have Bazaar installed, you
can grab your own branch of the code like this::

     bzr branch lp:mailman.client

You may contact the author via barry@python.org.


Copyright
=========

Copyright (C) 2010 by The Free Software Foundation, Inc.

This file is part of mailman.client.

mailman.client is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your option)
any later version.

mailman.client is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
details.

You should have received a copy of the GNU Lesser General Public License along
with mailman.client.  If not, see <http://www.gnu.org/licenses/>.


Table of Contents
=================

.. toctree::

    docs/using.txt
    NEWS.txt

.. _`simple guide`: docs/using.html
