Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tubone24/redmine_slack_notify

The script that access the Redmine server in the private environment, detects ticket updates, and notifies Slack.
https://github.com/tubone24/redmine_slack_notify

notification python redmine slack

Last synced: 1 day ago
JSON representation

The script that access the Redmine server in the private environment, detects ticket updates, and notifies Slack.

Host: GitHub
URL: https://github.com/tubone24/redmine_slack_notify
Owner: tubone24
License: mit
Created: 2020-03-01T02:02:57.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2023-12-15T17:43:42.000Z (about 1 year ago)
Last Synced: 2024-04-13T04:55:38.263Z (9 months ago)
Topics: notification, python, redmine, slack
Language: Python
Homepage:
Size: 213 KB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # redmine_slack_notify

![logo](./docs/images/logo.png)

[![license](https://img.shields.io/github/license/tubone24/elixir_performance_tool.svg)](LICENSE)

[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

The script that access the Redmine server in the private environment, detects ticket updates, and notifies Slack.

## Table of Contents

- [Background](#background)

- [Install](#install)

- [Usage](#usage)

- [API](#api)

- [Contributing](#contributing)

- [License](#license)

## Background

In the workplace where I work, I use Redmine built in a private environment for sharing information between stakeholders.

I wanted to share the update of Redmine Issue and its contents to Slack used by the development team,

Since Redmine server can only be accessed in a private environment, Slack's RSS Integration could not be used.

So, I thought about creating a Python script that runs on the PC (Raspberry PI) that was left behind in development, and notified Redmine of updates via the script.

## Install

### Precondition

- Python3.6 or more

### Install dependencies

```

pip install -r requirements.txt

```

### Edit your environment

```

mv .env.sample .env

vi .env

```

Config(.env)

```

URL=https:/xxxxxxx/xxxxxx/issues.csv                             # Endpoint that download issues.csv on your redmine server(!Check filter and must sort by updated DESC)

WEB_HOOK_URL_DAILY=https://hooks.slack.com/services/xxxxxx       # Incoming WEBHOOK for Daily notify

WEB_HOOK_URL_EACH=https://hooks.slack.com/services/xxxx          # Incoming WEBHOOK notify when detecting updating 

LOOP_INTERVAL=1       # Loop interval for detecting redmines updating

DAILY_HOUR=9          # Daily notify hours

DAILY_MINUTES=10      # Daily notify minutes (this examples sets 9:10)

```

#### [Note] How to get the URL for getting issue.csv

- First, Open Chrome developer tool(Push F12)

- Second, Show your project and **disabled all filter** and also **sort updated descending order**

![1](docs/images/1.png)

- Click exporting other format CSV

![2](docs/images/2.png)

- Choose the berow and click export

  - **selected columns**

  - check **description**, **latest note**

  - Encoding **UTF-8**

  

![3](docs/images/3.png)

- Watch developer tool **network tab** and check downloading issues.csv

![4](docs/images/4.png) 

- select **Copy link address**, this is your issues.csv download URL!

![5](docs/images/5.png)

## Usage

```

cd src 

python main.py

```

## Contributing

See [the contributing file](CONTRIBUTING.md)!

PRs accepted.

Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.

## License

[MIT © tubone24.](LICENSE)