A mailgun integration for scrapy.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
scrapymailgun
.gitignore
LICENSE
Makefile
README.md
requirements.txt
setup.py

README.md

Scrapy-mailgun: Mailgun integration for Scrapy

A mailgun integration for scrapy.

Quick Start

Install via pip:

$ pip install scrapy-mailgun

What's available right now is an EmailReport extension, that allows you to send a report once a spider is done through mailgun.

Configure:

EXTENSIONS = {
    'scrapymailgun.extensions.EmailReport': True,
}

SM_DOMAIN = 'api.mailgun.net/v3/XXXXXXXXXXXXXXXX.mailgun.org'
SM_KEY = 'key-XXXXXXXXXXXXXXXXX'
SM_FROM = 'from-email@acme.org'
SM_TO = 'to-email@acme.org'  # comma sparated

SM_EMAIL_REPORT_TMPL_SUBJECT = 'Your spider [{{spider.name}}] is done: {{reason}}'
SM_EMAIL_REPORT_TMPL_BODY = 'job stats: {{ spider.crawler.stats._stats }}'

Templates

Currently verbatim template strings are supported for flexible scraper configuration (you can change these remotely with no deploy).

As for template variables, what's available to you is your spider and reason instances directly. Do what ever you want with those in the templates.

Developers

Set up a development environment

$ pip install -r requirements.txt

Development

  • Dependencies: list them in requirements.txt

Release

  • Dependencies: list them in setup.py under install_requires:
install_requires=['peppercorn'],

Then:

$ make dist && make release

Contributing

Fork, implement, add tests, pull request, get my everlasting thanks and a respectable place here :).

Thanks:

To all Contributors - you make this happen, thanks!

Copyright

Copyright (c) 2017 Dotan Nahum @jondot. See LICENSE for further details.