https://github.com/tldr-pages/tldr-bot
:robot: A simple bot that performs automation tasks on the main tldr repo
https://github.com/tldr-pages/tldr-bot
automation bot continuous-integration hacktoberfest tldr tldr-pages
Last synced: 5 months ago
JSON representation
:robot: A simple bot that performs automation tasks on the main tldr repo
- Host: GitHub
- URL: https://github.com/tldr-pages/tldr-bot
- Owner: tldr-pages
- License: mit
- Created: 2017-04-27T18:28:04.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T01:03:29.000Z (about 1 year ago)
- Last Synced: 2025-06-02T11:55:59.062Z (7 months ago)
- Topics: automation, bot, continuous-integration, hacktoberfest, tldr, tldr-pages
- Language: Python
- Homepage: https://github.com/tldr-bot
- Size: 33.2 KB
- Stars: 29
- Watchers: 8
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tldr-bot
A simple [bot](https://github.com/tldr-bot) that performs automation tasks on the main [tldr repository](https://github.com/tldr-pages/tldr).
## Quick start
- Generate a GitHub personal access token with the `repo` scope and then set the needed environment variables:
```sh
FLASK_APP=/path/to/app/tldr_bot.py
BOT_TOKEN=
BOT_USERNAME=
REPO_SLUG=tldr-pages/tldr
PORT=
```
Then run the app using Flask:
```sh
flask run --port=$PORT
```
## Run as a service
See the [`tldr-bot.service`](/tldr-bot.service) file for an example systemd unit configuration.
Typically, the service is running under uWSGI and fronted by nginx. So you need to set the proper nginx config too.
```sh
location / {
include uwsgi_params;
uwsgi_pass 127.0.0.1:6129;
}
```