Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/dmsimard/linkbot

Last synced: 2 days ago
JSON representation

Host: GitHub
URL: https://github.com/dmsimard/linkbot
Owner: dmsimard
Created: 2020-09-11T03:16:33.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2021-11-01T21:15:12.000Z (about 3 years ago)
Last Synced: 2024-11-10T11:47:00.308Z (2 months ago)
Language: Python
Size: 29.3 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 7
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# linkbot

Uses the [Errbot](https://errbot.readthedocs.io/en/latest/index.html) python bot framework to expand links.

It's kind of like Slack when it expands links:

![slack-expand](https://raw.githubusercontent.com/dmsimard/linkbot/master/docs/images/slack-expand.png)

It is usable across the [different messaging backends](https://errbot.readthedocs.io/en/latest/features.html) (like IRC!) supported by Errbot.

# Setting up and running

```
git clone https://github.com/dmsimard/linkbot
cd linkbot
# Tweak config.py if need be
python3 -m venv /path/to/venv
/path/to/venv/bin/pip install -r requirements.txt
/path/to/venv/bin/errbot
```

## GitHub Links

The following settings must be set in ``config.py``:
- ``GITHUB_USERNAME``: your github username
- ``GITHUB_PASSWORD``: a github [token](https://github.com/settings/tokens)
- ``GITHUB_PR_TEMPLATE``: a f-string formatted template that will be used to expand the pr

When seeing a GitHub pull request link, linkbot will reply to the message based on the configured template, for example:

```
> contributor: anyone available to check this pr ? https://github.com/dmsimard/linkbot/pull/3
> linkbot: https://github.com/dmsimard/linkbot/pull/3 | open, created 2020-09-11T03:22:14Z by dmsimard: Add a new .meta file [documentation,enhancement,meta]
```