Metadata-Version: 2.0
Name: bartender
Version: 2.3.3
Summary: Beergarden Backend
Home-page: https://beer-garden.io
Author: The beer-garden Team
Author-email: bartender@beer-garden.io
License: MIT
Description-Content-Type: UNKNOWN
Keywords: bartender beer beer-garden beergarden
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: bg-utils (>=2.3.1)
Requires-Dist: pika (==0.11.0)
Requires-Dist: pyrabbit2 (==1.0.0)
Requires-Dist: futures (==3.1.1); python_version < "3.0"
Requires-Dist: subprocess32 (==3.2.7); python_version < "3.0"

=========
Bartender
=========

Bartender is the beer-garden backend. It's responsible for maintaining plugin health/status and running the actual plugins.

|pypi| |travis| |codecov| |docs| |pyup|

.. |pypi| image:: https://img.shields.io/pypi/v/bartender.svg
   :target: https://pypi.python.org/pypi/bartender
   :alt: PyPI

.. |travis| image:: https://img.shields.io/travis/beer-garden/bartender.svg
   :target: https://travis-ci.org/beer-garden/bartender?branch=master
   :alt: Build Status

.. |codecov| image:: https://codecov.io/gh/beer-garden/bartender/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/beer-garden/bartender
   :alt: Code Coverage

.. |docs| image:: https://readthedocs.org/projects/bartender/badge/?version=latest
   :target: https://bartender.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

.. |pyup| image:: https://pyup.io/repos/github/beer-garden/bartender/shield.svg
   :target: https://pyup.io/repos/github/beer-garden/bartender/
   :alt: Pyup Updates

Getting Started
===============

Pre-requisites
--------------

* Python >= 2.7, 3.4
* pip
* Connectivity to MongoDB Server  - (Tested on 3.4)
* Connectivity to Rabbitmq-Server - (Tested on 3.6)


Get Up and Running
------------------

When installed from pip you can simply:

.. code-block:: console

    $ bartender -c /path/to/config.json

These are the minimum required steps once you have all the pre-requisites up and running.

.. code-block:: console

    $ git clone https://github.com/beer-garden/bartender.git
    $ cd bartender
    $ pip install -r requirements.txt
    $ ./bin/app.sh # Requires brew-view to be running


There are several plugins that are loaded by default. You can view them in the brew-view UI.


Testing
=======

Running the tests:

.. code-block:: console

    $ make test

Generating coverage:

.. code-block:: console

    $ make coverage

Linting:

.. code-block:: console

    $ make lint

Credits
=======

* Doug Hellmann (@doughellmann) - Doug originally owned the bartender name but was willing to allow us to have it so that we didn't have to change a lot of documentation. Thanks very much Doug!


