Metadata-Version: 2.4
Name: beer_garden
Version: 3.33.1
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
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.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Description-Content-Type: text/markdown
Requires-Dist: brewtils>=3.33.0
Requires-Dist: apispec<7,>=6.7
Requires-Dist: apispec-webframeworks<2,>1
Requires-Dist: apscheduler<4
Requires-Dist: more-itertools<11
Requires-Dist: wrapt
Requires-Dist: elastic-apm
Requires-Dist: ldap3>=2.9.1
Requires-Dist: pyrabbit2<2
Requires-Dist: pyjwt>=2.4.0
Requires-Dist: passlib<1.8
Requires-Dist: prometheus-client<1
Requires-Dist: pyyaml<7
Requires-Dist: stomp.py<9,>=7
Requires-Dist: tornado<7
Requires-Dist: urllib3<3
Requires-Dist: watchdog<6.1
Requires-Dist: pymongo<4.16
Requires-Dist: mongoengine>=0.29.1
Requires-Dist: python-box<8
Requires-Dist: ruamel.yaml<0.19
Requires-Dist: yapconf<1.0
Requires-Dist: marshmallow<4.1,>=4.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: requires-dist
Dynamic: summary



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

This is the Beer-garden application backend.

[![PyPi Version](https://img.shields.io/pypi/v/beer-garden.svg)](https://pypi.python.org/pypi/beer-garden/)
![Python](https://img.shields.io/badge/python-3.11-blue.svg)
[![CodeCov](https://codecov.io/gh/beer-garden/beer-garden/branch/develop/graph/badge.svg)](https://codecov.io/gh/beer-garden/beer-garden)


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

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

* Python >= 3.11
* pip
* Connectivity to MongoDB Server  - (Tested on 6.0, Optimized for 7.0+)
* Connectivity to Rabbitmq-Server - (Tested on 3.8)


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

When installed from pip you can simply:

```
$ beer-garden -c /path/to/config.json
```
These are the minimum required steps once you have all the pre-requisites up and running.

```
$ 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:

```
$ make test
```

Generating coverage:

```
$ make coverage
```

Linting:
```
$ 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!
