# sentry-wxwork

**Repository Path**: spwx/sentry-wxwork

## Basic Information

- **Project Name**: sentry-wxwork
- **Description**: sentry-wxwork 是一个 Sentry 的企业微信集成插件，可以让 sentry 支持通过企业微信发送通知和单点登录（SSO Login）
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://www.oschina.net/p/sentry-wxwork
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 2
- **Created**: 2021-03-07
- **Last Updated**: 2021-03-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 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')
```