Commit 5d95abbe authored by Simon Hanna's avatar Simon Hanna

Update documentation

parent e1a2ec58
Python bindings for the Mailman 3 REST API.
..
This file is part of mailman.client.
This file is part of mailmanclient.
mailman.client is free software: you can redistribute it and/or modify it
mailmanclient 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, version 3 of the License.
mailman.client is distributed in the hope that it will be useful, but
mailmanclient 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.
......@@ -20,7 +20,7 @@ Python bindings for the Mailman 3 REST API.
mailman.client
==============
The ``mailman.client`` library provides official Python bindings for the GNU
The ``mailmanclient`` library provides official Python bindings for the GNU
Mailman 3 REST API.
Note that the test suite current requires that a Mailman 3 server be running.
......@@ -32,7 +32,7 @@ is not necessary in order to run these tests.
Requirements
============
``mailman.client`` requires Python 2.6 or newer.
``mailmanclient`` requires Python 2.6 or newer.
Project details
......
......@@ -2,24 +2,22 @@
mailman.client - Python bindings for the Mailman 3 REST API
===========================================================
This package is called ``mailman.client``.
This package is called ``mailmanclient``.
Requirements
============
``mailman.client`` requires Python 2.6 or newer, and is compatible with Python
3 when used with ``2to3``.
``mailmanclient`` requires Python 2.6 or newer, and is compatible with Python 3
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:
the form of doctests. The manual is also available online at:
http://package.python.org/mailman.client
http://mailmanclient.readthedocs.org/en/latest/
Project details
......@@ -35,12 +33,12 @@ You should report bugs at:
You can download the latest version of the package either from the Cheeseshop:
http://pypi.python.org/pypi/mailman.client
http://pypi.python.org/pypi/mailmanclient
or from the Launchpad page above. Of course you can also just install it with
or from the GitLab page above. Of course you can also just install it with
``pip`` from the command line::
% sudo pip mailman.client
% sudo pip mailmanclient
You can grab the latest development copy of the code using Git, from the Gitlab
home page above. If you have Git installed, you can grab your own branch of
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment