.. image:: https://img.shields.io/pypi/l/groundwork-utilities.svg
   :target: https://pypi.python.org/pypi/groundwork-utilities
   :alt: License
.. image:: https://img.shields.io/pypi/pyversions/groundwork-utilities.svg
   :target: https://pypi.python.org/pypi/groundwork-utilities
   :alt: Supported versions
.. image:: https://readthedocs.org/projects/groundwork-utilities/badge/?version=latest
   :target: https://readthedocs.org/projects/groundwork-utilities/
.. image:: https://travis-ci.org/useblocks/groundwork-utilities.svg?branch=master
   :target: https://travis-ci.org/useblocks/groundwork-utilities
   :alt: Travis-CI Build Status
.. image:: https://coveralls.io/repos/github/useblocks/groundwork-utilities/badge.svg?branch=master
   :target: https://coveralls.io/github/useblocks/groundwork-utilities?branch=master
.. image:: https://img.shields.io/scrutinizer/g/useblocks/groundwork-utilities.svg
   :target: https://scrutinizer-ci.com/g/useblocks/groundwork-utilities/
   :alt: Code quality
.. image:: https://img.shields.io/pypi/v/groundwork-utilities.svg
   :target: https://pypi.python.org/pypi/groundwork-utilities
   :alt: PyPI Package latest release

Welcome to groundwork utilities
===============================

.. _groundwork: https://groundwork.readthedocs.io

.. sidebar:: groundwork framework

   `groundwork`_ is a plugin based Python application framework, which can be used to create various types of applications:
   console scripts, desktop apps, dynamic websites and more.

   Visit `groundwork.useblocks.com <http://groundwork.useblocks.com>`_
   or read the `technical documentation <https://groundwork.readthedocs.io>`_ for more information.

This Python package is designed for applications, which are based on the
`groundwork application framework <https://groundwork.readthedocs.io>`_.

Most of its plugins and patterns are focused on application monitoring.

This package contains the following groundwork extensions:

 * Plugins

  * **GwResourceMonitor** - Prints used hardware resources on command line

Installation
------------

To install ``groundwork-utilities`` simply use ``pip``::

   pip install groundwork-utilities

Content
-------

.. toctree::
   :maxdepth: 2

   patterns/index
   plugins/index