=========================
MASH Client Documentation
=========================

.. image:: https://www.travis-ci.com/SUSE-Enceladus/mash-client.svg?branch=master
   :target: https://www.travis-ci.com/SUSE-Enceladus/mash-client

.. image:: https://img.shields.io/pypi/pyversions/mash-client.svg
   :target: https://pypi.org/project/mash-client/

.. image:: https://img.shields.io/pypi/l/mash-client.svg
   :target: https://pypi.org/project/mash-client/

.. toctree::
   :maxdepth: 3
   :hidden:

   Installation <install>
   Configuration <config>
   API <api>
   Modules <modules/mash_client>

Overview
--------

**MASH Client** provides a command line utilty to interface with the MASH
server REST API.

Contributing
------------

Contributions to MASH Client are welcome and encouraged. See `CONTRIBUTING`_ for
info on getting started.

.. _CONTRIBUTING: https://github.com/SUSE-Enceladus/mash-client/blob/master/CONTRIBUTING.md

Issues/Enhancements
-------------------

Please submit issues and requests to `Github`_.

.. _Github: https://github.com/SUSE-Enceladus/mash-client/issues

License
-------

Copyright (c) 2019 SUSE LLC. All rights reserved.

Distributed under the terms of GPL-3.0+ license, see `LICENSE`_ for details.

.. _LICENSE: https://github.com/SUSE-Enceladus/mash-client/blob/master/LICENSE