Metadata-Version: 2.1
Name: sentry-wxwork
Version: 1.2.0
Summary: Plugin for Sentry which integrates with WeChat Work.
Home-page: https://github.com/tsl0922/sentry-wxwork
Author: Shuanglei Tao
Author-email: tsl0922@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Bug Tracking
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: System :: Monitoring
Description-Content-Type: text/markdown

# Sentry WeChat Work [![pypi](https://badge.fury.io/py/sentry-wxwork.svg)](https://pypi.python.org/pypi/sentry-wxwork) [![Downloads](https://pepy.tech/badge/sentry-wxwork)](https://pepy.tech/project/sentry-wxwork)

Plugin for [Sentry](https://github.com/getsentry/sentry) which allows sending notification and SSO Login via [WeChat Work](https://work.weixin.qq.com).

## Installation

> **NOTE:** sentry 20.x removed support for legacy plugins, so this plugin only works for sentry 9.x-10.x.

### Prepare

- Install the plugin:
    - [onpremise](https://github.com/getsentry/onpremise): put `sentry-wxwork` to `requirements.txt`
    - manual: `pip install sentry-wxwork`
- Obtain required config from WeChat Work admin console ([Read Me](https://work.weixin.qq.com/api/doc/90000/90135/90664)).

### Notification

On (Legacy) Integrations page, find `WeChat Work`, enable and configure it. 

### SSO Login

Add the following settings to your `sentry.conf.py`:

```python
WXWORK_CORP_ID = ''
WXWORK_SECRET = ''
WXWORK_AGENT_ID = ''
```

or, if you prefer setting it via environment variables:

```python
if 'WXWORK_CORP_ID' in os.environ:
    WXWORK_CORP_ID = env('WXWORK_CORP_ID')
    WXWORK_SECRET = env('WXWORK_SECRET')
    WXWORK_AGENT_ID = env('WXWORK_AGENT_ID')
```



