Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rajeevs1992/mailmancli

Project to build command line tools for better usability of Mailman.The project has two phases, Mailman Command line tools and Mailman CLI The command line tools is a set of userspace commands that can give a quick glance of the system.It can be useful for automation tasks by making functionalities a command away. The CLI for mailman is to provide a comfortable shell through which the users can query data in the installation based upon the state, using a understandable query language.
https://github.com/rajeevs1992/mailmancli

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/rajeevs1992/mailmancli
Owner: rajeevs1992
License: lgpl-3.0
Created: 2014-09-26T03:33:24.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2016-05-31T06:46:51.000Z (over 8 years ago)
Last Synced: 2023-03-12T08:41:11.377Z (almost 2 years ago)
Language: Python
Size: 551 KB
Stars: 0
Watchers: 1
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: COPYING.LESSER

Awesome Lists containing this project

README

        
>This is not an official piece of software. This is a Github mirror of

>my GSoC 2014 project with mailman. Here are the links to the official

>mailman projects:

>https://code.launchpad.net/~mailman-coders

>https://code.launchpad.net/~mailman-coders/mailman.client

===========================================================

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

===========================================================

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

..

    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, version 3 of the License.

    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 .

==============

mailman.client

==============

The ``mailman.client`` 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.

It should be running using a dummy or throw-away database, as this will make

changes to the running system.  TBD: mock the real Mailman engine so that it

is not necessary in order to run these tests.

Requirements

============

``mailman.client`` requires Python 2.6 or newer.

Project details

===============

You may download the latest version of the package from the Python

`Cheese Shop`_ or from Launchpad_.

You can also install it via ``easy_install`` or ``pip``.::

    % sudo easy_install mailman.client

    % sudo pip install mailman.client

See the Launchpad project page for access to the Bazaar branch, bug report,

etc.

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

Acknowledgements

================

Many thanks to Florian Fuchs for his contribution of an initial REST client.

.. _`Cheese Shop`: http://pypi.python.org/mailman.client

.. _Launchpad: https://launchpad.net/mailman.client

Table of Contents

=================

.. toctree::

    src/mailmanclient/docs/using.txt

    src/mailmanclient/cli/docs/using_cli_shell.txt

    src/mailmanclient/cli/docs/using_cli_tools.txt

    src/mailmanclient/cli/docs/writing_a_new_command.txt

    src/mailmanclient/cli/client/parsers/README.txt

    src/mailmanclient/NEWS.txt

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