https://github.com/python/webhook-mailer
GitHub Webhooks -> Email
https://github.com/python/webhook-mailer
Last synced: 5 months ago
JSON representation
GitHub Webhooks -> Email
- Host: GitHub
- URL: https://github.com/python/webhook-mailer
- Owner: python
- License: apache-2.0
- Created: 2024-06-25T15:03:10.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-06-26T16:30:52.000Z (12 months ago)
- Last Synced: 2025-01-15T08:32:38.311Z (5 months ago)
- Language: Python
- Size: 42 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A webhook to send every [CPython][cpython] commit to
[python-checkins][python-checkins] mailing list. It's based on
[python/the-knights-who-say-ni][ni] written by Brett Cannon.
## Requirements
* CPython 3.7
* aiohttp
* aiosmtplib
See [requirements](requirements) for details.
## Configuration
You can use following environment variables to configure the mailer
webhook:
* `SENDER_EMAIL`: This is required.
* `RECIPIENT_EMAIL`: This is required.
* `SMTP_HOSTNAME`: This is optional. Defaults to `'localhost'`.
* `SMTP_PORT`: This is optional. Defaults to `1025`.
* `SMTP_USERNAME`: This is optional.
* `SMTP_PASSWORD`: This is optional.
* `PORT`: This is optional. Defaults to `8585`.
## Usage
```sh
$ [email protected] [email protected] SMTP_USERNAME=spam SMTP_PASSWORD=eggs python3 mailer.py
```
## Development
You can use [aiosmtpd][aiosmtpd] as an SMTP server during development:
```sh
$ python -m aiosmtpd -nd -l localhost:1025
```
## Testing
Testing requires [tox][tox] to be installed, then is as simple as running
```sh
$ tox
```
To run the linter, reformatter, and tests in one shot.
[cpython]: https://github.com/python/cpython
[python-checkins]: https://mail.python.org/mailman/listinfo/python-checkins
[ni]: https://github.com/python/the-knights-who-say-ni
[aiosmtpd]: https://aiosmtpd.readthedocs.io/en/latest/
[tox]: https://tox.wiki