Metadata-Version: 2.1
Name: beer-garden
Version: 3.28.2
Summary: Beergarden Application
Home-page: https://beer-garden.io
Author: The Beer Garden Team
Author-email: beer@beer-garden.io
License: MIT
Keywords: 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 :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: apispec <0.39
Requires-Dist: apscheduler <4
Requires-Dist: python-box >=3.3.0
Requires-Dist: brewtils >=3.28.0
Requires-Dist: marshmallow <3
Requires-Dist: mongoengine <0.21
Requires-Dist: more-itertools <9
Requires-Dist: motor <3
Requires-Dist: passlib <1.8
Requires-Dist: prometheus-client <1
Requires-Dist: pyyaml <5.4
Requires-Dist: pyrabbit2 <2
Requires-Dist: pytz <2021
Requires-Dist: pyjwt >=2.4.0
Requires-Dist: ruamel.yaml <0.17
Requires-Dist: stomp.py <6.2.0
Requires-Dist: tornado <7
Requires-Dist: urllib3 <2
Requires-Dist: watchdog >2.1.0
Requires-Dist: wrapt
Requires-Dist: yapconf >=1.0.0
Requires-Dist: elastic-apm


===========================
Beer-Garden App
===========================

This is the Beer-garden application backend.

|pypi| |travis| |codecov|

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

.. |travis| image:: https://img.shields.io/travis/beer-garden/beer-garden.svg
   :target: https://travis-ci.com/beer-garden/beer-garden
   :alt: Build Status

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

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

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

* Python >= 3.7
* 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

    $ beer-garden -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/beer-garden.git
    $ cd src/app
    $ pip install -r requirements.txt
    $ ./bin/app.sh


There are several plugins that are loaded by default. You can view them in the 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 back when the application needed the name. Thanks very much Doug!


