Metadata-Version: 2.1
Name: contentrules.slack
Version: 2.0.1
Summary: Slack content rule action for Plone.
Home-page: https://pypi.python.org/pypi/contentrules.slack
Author: Pendect Tech
Author-email: opensource@pendect.com
License: GPL version 2
Project-URL: PyPI, https://pypi.python.org/pypi/contentrules.slack
Project-URL: Source, https://github.com/collective/contentrules.slack
Project-URL: Tracker, https://github.com/collective/contentrules.slack/issues
Project-URL: Documentation, https://collective.github.io/contentrules.slack
Keywords: Python Plone Slack ContentRules Pendect
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: Addon
Classifier: Framework :: Plone :: 6.0
Classifier: Programming Language :: Python
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: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Requires-Python: >=3.8.0
Description-Content-Type: text/markdown
Provides-Extra: test
License-File: LICENSE.GPL


<div align="center"><img alt="logo" src="./docs/_static/images/icon.png" width="70" /></div>

<h1 align="center">contentrules.slack</h1>

<div align="center">

[![PyPI](https://img.shields.io/pypi/v/contentrules.slack)](https://pypi.org/project/contentrules.slack/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/contentrules.slack)](https://pypi.org/project/contentrules.slack/)
[![PyPI - Wheel](https://img.shields.io/pypi/wheel/contentrules.slack)](https://pypi.org/project/contentrules.slack/)
[![PyPI - License](https://img.shields.io/pypi/l/contentrules.slack)](https://pypi.org/project/contentrules.slack/)
[![PyPI - Status](https://img.shields.io/pypi/status/contentrules.slack)](https://pypi.org/project/contentrules.slack/)


[![PyPI - Plone Versions](https://img.shields.io/pypi/frameworkversions/plone/contentrules.slack)](https://pypi.org/project/contentrules.slack/)

[![Code analysis checks](https://github.com/collective/contentrules.slack/actions/workflows/code-analysis.yml/badge.svg)](https://github.com/collective/contentrules.slack/actions/workflows/code-analysis.yml)
[![Tests](https://github.com/collective/contentrules.slack/actions/workflows/tests.yml/badge.svg)](https://github.com/collective/contentrules.slack/actions/workflows/tests.yml)
![Code Style](https://img.shields.io/badge/Code%20Style-Black-000000)

[![GitHub contributors](https://img.shields.io/github/contributors/collective/contentrules.slack)](https://github.com/collective/contentrules.slack)
[![GitHub Repo stars](https://img.shields.io/github/stars/collective/contentrules.slack?style=social)](https://github.com/collective/contentrules.slack)

</div>

**contentrules.slack** is a package providing a [Plone](https://plone.org/) content rules action to post a message on Slack.


# Installation

This package supports Plone sites using Volto and ClassicUI.

For proper Volto support, the requirements are:

* plone.restapi >= 8.34.0
* Volto >= 16.10.0

Add **contentrules.slack** to the Plone installation using `pip`:

```bash
pip install contentrules.slack
```

or add it as a dependency on your package's `setup.py`

```python
    install_requires = [
        "contentrules.slack",
        "Plone",
        "plone.restapi",
        "setuptools",
    ],
```

Start Plone and go to the `Content Rules` Control Panel.

No additional configuration is needed for Volto support.


## Source Code and Contributions

If you want to help with the development (improvement, update, bug-fixing, ...) of `contentrules.slack` this is a great idea!

- [Issue Tracker](https://github.com/collective/contentrules.slack/issues)
- [Source Code](https://github.com/collective/contentrules.slack/)
- [Documentation](https://collective.github.io/contentrules.slack)


We appreciate any contribution and if a release is needed to be done on PyPI, please just contact one of us.

## Development

You need a working `python` environment (system, `virtualenv`, `pyenv`, etc) version 3.8 or superior.

Then install the dependencies and a development instance using:

```bash
make build
```

To run tests for this package:
By default, we use the latest Plone version in the `6.x` series.

## Translations

This product has been translated into:

- English (Érico Andrei)
- Português do Brasil (Rudá Porto)
- Deutsch (Yael Biran)
- Español (Álvaro Hurtado Mochón)

## License

The project is licensed under GPLv2.

## One Last Thing

Originally Made in Berlin, with love, by your friends @ Briefy and Pendect.

Now maintained by the [Plone Collective](https://github.com/collective)


# Contributors

- Érico Andrei, @ericof
- Rudá Porto, @rudaporto
- Álvaro Hurtado Mochón, @alvarohurtado84
- Yael Biran


# Changelog

## 2.0.1 (2023-03-10)


- Use [`pytest_plone`](https://pypi.org/project/pytest-plone/)
  [ericof]

- Deploy documentation to https://collective.github.io/contentrules.slack
  [ericof]



## 2.0.0 (2023-02-07)

- Use `pytest` instead of `unittest`
  [ericof]

- Drop dependency on `ftw.slacker`
  [ericof]

- Drop support to Plone 5.2
  [ericof]

- Support to Plone 6.0, Python 3.8 to 2.11
  [ericof]

- Update documentation
  [ericof]


## 1.0.1 (2020-04-25)

- Fix "TypeError: expected string or bytes-like object" when one attribute of action is not set.
  [ericof]


## 1.0.0 (2019-11-28)

- Add Plone 5.2 / Python 3 support.
  [ericof]

- Drop Python 2.7 support.
  [ericof]


## 1.0.0a1 (2017-10-17)

- Initial release.
  [ericof]


