https://github.com/fastai/fastwebhook
A simple GitHub webhook server
https://github.com/fastai/fastwebhook
cli github nbdev python webhook webserver
Last synced: 19 days ago
JSON representation
A simple GitHub webhook server
- Host: GitHub
- URL: https://github.com/fastai/fastwebhook
- Owner: fastai
- License: apache-2.0
- Created: 2020-09-30T13:39:41.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-05-23T01:14:18.000Z (over 3 years ago)
- Last Synced: 2025-04-23T15:03:29.552Z (9 months ago)
- Topics: cli, github, nbdev, python, webhook, webserver
- Language: Jupyter Notebook
- Homepage: https://fastai.github.io/fastwebhook/
- Size: 1.11 MB
- Stars: 6
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# fastwebhook
> A simple GitHub webhook server.
At this stage, this is only able to send tweets on software releases. It's very early stage still. You'll need to set up a webhook on GitHub.
## Install
First install the package:
`pip install fastwebhook`
Then create an file called `twitter.ini` containing:
```
gh_secret:
consumer_key:
consumer_secret:
access_token:
access_token_secret:
```
`gh_secret` is the webhook secret you set in GitHub. The remaining are your twitter API keys.
## How to use
Run `fastwebhook` to run the web server. Pass `--help` for info about optional arguments. Either run this from the same directory that contains your `twitter.ini`, or else pass `--inifile` along with the full path to your ini file.
### Systemd service
The following commands should all be run as root (i.e. prepend `sudo` to the commands).
To install it as a systemd service (which is probably what you want), run `fastwebhook_install`. Pass `--help` for info about optional arguments, which will be passed to `fastwebhook` by the service.
After the service is installed, run `systemctl start fastwebhook` to start it, `systemctl status fastwebhook` to check it, and `systemctl stop fastwebhook` to stop it. Run `systemctl enable fastwebhook` to have it start automatically on boot. Run `journalctl -eu fastwebhook`