<commit_before>luigi-slack
===========

`luigi-slack` adds Slack notifications to Luigi.

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

From the cheese shop::

    pip install luigi_slack


From GitHub::

    git clone https://github.com/bonzanini/luigi-slack
    cd luigi-slack
    python setup.py install


Current status
--------------

At the moment this is a proof-of-concept, version 0.1

This is **experimental** and the API could change drastically


Features
--------

Roadmap to version 1.0

- Python 3
- Configurable notifications on different events
- Straightforward interface


Usage
-----

Example of usage::

```python
import luigi
from luigi_slack import SlackBot, notify

# ...

slacker = SlackBot(token='my-token',
                   channels=['mychannel', 'anotherchannel'])
with notify(slacker):
    luigi.run(main_task_cls=MyTask)
```

--------

Credits: inspired by `luigi-monitor <https://github.com/hudl/luigi-monitor>`_.<commit_msg>Syntax highlight fix, using rst not md<commit_after>luigi-slack
===========

`luigi-slack` adds Slack notifications to Luigi.

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

From the cheese shop::

    pip install luigi_slack


From GitHub::

    git clone https://github.com/bonzanini/luigi-slack
    cd luigi-slack
    python setup.py install


Current status
--------------

At the moment this is a proof-of-concept, version 0.1

This is **experimental** and the API could change drastically


Features
--------

Roadmap to version 1.0

- Python 3
- Configurable notifications on different events
- Straightforward interface


Usage
-----

Example of usage::

.. code-block:: python
    import luigi
    from luigi_slack import SlackBot, notify

    # ...

    slacker = SlackBot(token='my-token',
                   channels=['mychannel', 'anotherchannel'])
    with notify(slacker):
        luigi.run(main_task_cls=MyTask)


--------

Credits: inspired by `luigi-monitor <https://github.com/hudl/luigi-monitor>`_.
{'fraction_non_alphanumeric': 0.14558595766649457, 'fraction_numerical': 0.005162622612287042, 'mean_word_length': 2.8300395256916997, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 4, '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': '280682', 'n_tokens_mistral': 627, 'n_tokens_neox': 579, 'n_words': 172}