<commit_before>Puppetboard
===========

[![image](https://travis-ci.org/voxpupuli/puppetboard.svg?branch=master)](https://travis-ci.org/voxpupuli/puppetboard)

[![image](https://coveralls.io/repos/github/voxpupuli/puppetboard/badge.svg?branch=master)](https://coveralls.io/github/voxpupuli/puppetboard?branch=master)

Puppetboard is a web interface to [PuppetDB](https://puppet.com/docs/puppetdb/latest/index.html) aiming to replace the reporting functionality of [Puppet Dashboard](http://docs.puppetlabs.com/dashboard/).

Puppetboard relies on the [pypuppetdb](https://pypi.python.org/pypi/pypuppetdb) library to fetch data from PuppetDB and is built with the help of the [Flask](http://flask.pocoo.org) microframework.

As of version 0.1.0 and higher, Puppetboard **requires** PuppetDB 3. Version 0.3.0 has been tested with PuppetDB versions 3 through 6.

At the current time of writing, Puppetboard supports the following Python versions:

* Python 3.6
* Python 3.7
* Python 3.8

![View of a node](screenshots/overview.png)

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

Puppetboard is now packaged and available on PyPi.

### Production

#### Puppet module

There is a [Puppet module](https://forge.puppetlabs.com/puppet/puppetboard) by [<NAME>](https://github.com/nibalizer) that takes care of installing Puppetboard for you.

You can install it with:

> puppet module install puppet-puppetboard

To see how to get it working with EL7 check out these [docs](https://github.com/voxpupuli/puppetboard/blob/master/docs/EL7.md).

#### Manual

To install it simply issue the following command:

``` {.sourceCode .bash}
$ pip install puppetboard
```

This will install Puppetboard and take care of the dependencies. If you do this Puppetboard will be installed in the so called site-packages or dist-packages of your Python distribution.

The complete path on Debian and Ubuntu systems would be `/usr/local/lib/pythonX.Y/lib/dist-packages/puppetboard` and on Fedora would be `/usr/lib/pythonX.Y/site-packages/puppetboard`

where X and Y are replaced by your major and minor python versions.

You will need this path in order to configure your HTTPD and WSGI-capable application server.

#### Packages

Native packages for your operating system will be provided in the near future.

<table>
<colgroup>
<col width="25%" />
<col width="15%" />
<col width="58%" />
</colgroup>
<thead>
<tr class="header">
<th align="left">OS</th>
<th align="left">Status</th>
<th align="left"></th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td align="left">Debian 6/Squeeze</td>
<td align="left">planned</td>
<td align="left">Requires Backports</td>
</tr>
<tr class="even">
<td align="left">Debian 7/Wheezy</td>
<td align="left">planned</td>
<td align="left"></td>
</tr>
<tr class="odd">
<td align="left">Ubuntu 13.04</td>
<td align="left">planned</td>
<td align="left"></td>
</tr>
<tr class="even">
<td align="left">Ubuntu 13.10</td>
<td align="left">planned</td>
<td align="left"></td>
</tr>
<tr class="odd">
<td align="left">CentOS/RHEL 5</td>
<td align="left">n/a</td>
<td align="left">Python 2.4</td>
</tr>
<tr class="even">
<td align="left">CentOS/RHEL 6</td>
<td align="left">planned</td>
<td align="left"></td>
</tr>
<tr class="odd">
<td align="left"><a href="https://build.opensuse.org/package/show/systemsmanagement:puppet/python-puppetboard">OpenSuSE 12/13</a></td>
<td align="left">available</td>
<td align="left">Maintained on <a href="https://build.opensuse.org/package/show/systemsmanagement:puppet/python-puppetboard">OpenSuSE Build Service</a></td>
</tr>
<tr class="even">
<td align="left"><a href="https://build.opensuse.org/package/show/systemsmanagement:puppet/python-puppetboard">SuSE LE 11 SP3</a></td>
<td align="left">available</td>
<td align="left">Maintained on <a href="https://build.opensuse.org/package/show/systemsmanagement:puppet/python-puppetboard">OpenSuSE Build Service</a></td>
</tr>
<tr class="odd">
<td align="left"><a href="https://aur.archlinux.org/packages/python2-puppetboard/">ArchLinux</a></td><commit_msg>remove old distribs from packaging in readme<commit_after>Puppetboard
===========

[![image](https://travis-ci.org/voxpupuli/puppetboard.svg?branch=master)](https://travis-ci.org/voxpupuli/puppetboard)

[![image](https://coveralls.io/repos/github/voxpupuli/puppetboard/badge.svg?branch=master)](https://coveralls.io/github/voxpupuli/puppetboard?branch=master)

Puppetboard is a web interface to [PuppetDB](https://puppet.com/docs/puppetdb/latest/index.html) aiming to replace the reporting functionality of [Puppet Dashboard](http://docs.puppetlabs.com/dashboard/).

Puppetboard relies on the [pypuppetdb](https://pypi.python.org/pypi/pypuppetdb) library to fetch data from PuppetDB and is built with the help of the [Flask](http://flask.pocoo.org) microframework.

As of version 0.1.0 and higher, Puppetboard **requires** PuppetDB 3. Version 0.3.0 has been tested with PuppetDB versions 3 through 6.

At the current time of writing, Puppetboard supports the following Python versions:

* Python 3.6
* Python 3.7
* Python 3.8

![View of a node](screenshots/overview.png)

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

Puppetboard is now packaged and available on PyPi.

### Production

#### Puppet module

There is a [Puppet module](https://forge.puppetlabs.com/puppet/puppetboard) by [<NAME>](https://github.com/nibalizer) that takes care of installing Puppetboard for you.

You can install it with:

> puppet module install puppet-puppetboard

To see how to get it working with EL7 check out these [docs](https://github.com/voxpupuli/puppetboard/blob/master/docs/EL7.md).

#### Manual

To install it simply issue the following command:

``` {.sourceCode .bash}
$ pip install puppetboard
```

This will install Puppetboard and take care of the dependencies. If you do this Puppetboard will be installed in the so called site-packages or dist-packages of your Python distribution.

The complete path on Debian and Ubuntu systems would be `/usr/local/lib/pythonX.Y/lib/dist-packages/puppetboard` and on Fedora would be `/usr/lib/pythonX.Y/site-packages/puppetboard`

where X and Y are replaced by your major and minor python versions.

You will need this path in order to configure your HTTPD and WSGI-capable application server.

#### Packages

Native packages for your operating system will be provided in the near future.

<table>
<colgroup>
<col width="25%" />
<col width="15%" />
<col width="58%" />
</colgroup>
<thead>
<tr class="header">
<th align="left">OS</th>
<th align="left">Status</th>
<th align="left"></th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td align="left"><a href="https://build.opensuse.org/package/show/systemsmanagement:puppet/python-puppetboard">OpenSuSE 12/13</a></td>
<td align="left">available</td>
<td align="left">Maintained on <a href="https://build.opensuse.org/package/show/systemsmanagement:puppet/python-puppetboard">OpenSuSE Build Service</a></td>
</tr>
<tr class="even">
<td align="left"><a href="https://build.opensuse.org/package/show/systemsmanagement:puppet/python-puppetboard">SuSE LE 11 SP3</a></td>
<td align="left">available</td>
<td align="left">Maintained on <a href="https://build.opensuse.org/package/show/systemsmanagement:puppet/python-puppetboard">OpenSuSE Build Service</a></td>
</tr>
<tr class="odd">
<td align="left"><a href="https://aur.archlinux.org/packages/python2-puppetboard/">ArchLinux</a></td>
{'fraction_non_alphanumeric': 0.16060977269633864, 'fraction_numerical': 0.010344358241459099, 'mean_word_length': 5.329026701119725, 'pattern_counts': {'":': 0, '<': 145, '<?xml version=': 0, '>': 147, 'https://': 28, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3449711', 'n_tokens_mistral': 2632, 'n_tokens_neox': 2502, 'n_words': 655}