<commit_before>puppet-zulip
=============

Description
-----------

A Puppet report handler for sending notifications to Zulip.  You'll
need a Zulip account.

Based on handlers by <NAME>!

Requirements
------------

* `puppet`

Installation & Usage
--------------------

1.  Install puppet_zulip as a module in your Puppet master's module
    path.

2.  Get an API bot email & key from zulip [here][https://zulip.com/#settings]

3.  Update the  `botemail`, `key` from above.
    Update the`type` (stream or private), , `to` (Stream name or email to send a private message), & `subject` (for stream subjects) variables in the file `zulip.yaml` and then copy the file to `/etc/puppet/` or for puppet enterpise '/etc/puppetlabs/puppet'.
    The `zulip_statuses` should be an array of statuses to send notifications for and defaults to `'failed'`. Specify `'all'` to receive notifications from all Puppet runs.

4. You can also use this by including the class in a manifest, with either parameters or hiera to set the settings. It will create the settings file in the correct place for you.

5.  Enable reports on your master `puppet.conf`

        [master]
        report = true
        reports = zulip
<commit_msg>Fix README.md link<commit_after>puppet-zulip
=============

Description
-----------

A Puppet report handler for sending notifications to Zulip.  You'll
need a Zulip account.

Based on handlers by <NAME>!

Requirements
------------

* `puppet`

Installation & Usage
--------------------

1.  Install puppet_zulip as a module in your Puppet master's module
    path.

2.  Get an API bot email & key from zulip [here](https://zulip.com/#settings)

3.  Update the  `botemail`, `key` from above.
    Update the`type` (stream or private), , `to` (Stream name or email to send a private message), & `subject` (for stream subjects) variables in the file `zulip.yaml` and then copy the file to `/etc/puppet/` or for puppet enterpise '/etc/puppetlabs/puppet'.
    The `zulip_statuses` should be an array of statuses to send notifications for and defaults to `'failed'`. Specify `'all'` to receive notifications from all Puppet runs.

4. You can also use this by including the class in a manifest, with either parameters or hiera to set the settings. It will create the settings file in the correct place for you.

5.  Enable reports on your master `puppet.conf`

        [master]
        report = true
        reports = zulip

{'fraction_non_alphanumeric': 0.12062577192260189, 'fraction_numerical': 0.004116920543433511, 'mean_word_length': 3.077181208053691, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, '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': '1905159', 'n_tokens_mistral': 744, 'n_tokens_neox': 721, 'n_words': 324}