/ghinbox

Create GitHub Issues via email

Primary LanguagePythonMIT LicenseMIT

Test Status Code Climate License

Deploy and Setup

  1. Deploy
  2. Fill in the config vars with your GitHub credencials and repository info
  3. Ensure you scale up the worker dyno heroku ps:scale worker:1 -a app-name
  4. Run heroku addons:open postmark -a app-name 1. Click through the wizard until you get to Get Started with your New Server 1. Select Process Inbound Mail 1. Make note of the inbound email address 1. Enter https://yourapp.herokuapp.com/hooks/postmark for the webhook URL
  5. Send an email to the inbound address provided by PostMark

Usage

Any emails sent to the POSTMARK_INBOUND_ADDRESS will automatically be converted into a new GitHub issue in your repository.

You can always retrieve the email address to submit issues to by running

heroku config:get POSTMARK_INBOUND_ADDRESS

You also might want to create an easily to remember email alias, rather than the random address Postmark provides. Postmark has instructions to configure an alias using Gmail or a Custom Domain.

Development

You can test the server locally by starting it with

python webapp.py

You can use curl to simulate calling the webhook

curl -H "Content-Type: application/json" -X POST http://localhost:5000/hooks/postmark -d '{"Subject": "test subject", "TextBody": "A long description"}'

The worker can be run with

rqworker