Metadata-Version: 2.1
Name: stack_alert
Version: 0.1.0
Summary: Be notified when interesting questions are posted to Stack Exchange sites.
Home-page: https://github.com/kalekundert/stack_alert
License: UNKNOWN
Author: Kale Kundert
Author-email: kale@thekunderts.net
Requires-Python: ~=3.6
Description-Content-Type: text/x-rst
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Requires-Dist: appdirs
Requires-Dist: docopt
Requires-Dist: excerpt-html
Requires-Dist: inform
Requires-Dist: jinja2
Requires-Dist: more_itertools
Requires-Dist: requests
Requires-Dist: toml
Requires-Dist: tqdm
Requires-Dist: sphinx ; extra == "docs"
Requires-Dist: sphinx_rtd_theme ; extra == "docs"
Requires-Dist: autoclasstoc ; extra == "docs"
Requires-Dist: pytest ; extra == "tests"
Requires-Dist: pytest-cov ; extra == "tests"
Requires-Dist: coveralls ; extra == "tests"
Project-URL: Bug Tracker, https://github.com/kalekundert/stack_alert/issues
Project-URL: Continuous Integration, https://github.com/kalekundert/stack_alert/actions
Project-URL: Documentation, https://stack_alert.readthedocs.io/en/latest/
Project-URL: Test Coverage, https://coveralls.io/github/kalekundert/stack_alert
Project-URL: Version Control, https://github.com/kalekundert/stack_alert
Provides-Extra: docs
Provides-Extra: tests

***********
Stack Alert
***********

Stack Alert is a program to notify you a question matching certain filters is 
asked on a Stack Exchange site.  Stack Exchange has a feature that allows you 
to be notified when questions matching certain tags are asked, but this is 
often so broad as to be useless.  Stack Alert instead allows you to filter 
using regular expressions against the title and body of the question.

.. image:: https://img.shields.io/pypi/v/stack_alert.svg
   :target: https://pypi.python.org/pypi/stack_alert

.. image:: https://img.shields.io/pypi/pyversions/stack_alert.svg
   :target: https://pypi.python.org/pypi/stack_alert

.. image:: https://img.shields.io/readthedocs/stack_alert.svg
   :target: https://stack_alert.readthedocs.io/en/latest/?badge=latest

.. image:: https://img.shields.io/github/workflow/status/kalekundert/stack_alert/Test%20and%20release/master
   :target: https://github.com/kalekundert/stack_alert/actions

.. image:: https://img.shields.io/coveralls/kalekundert/stack_alert.svg
   :target: https://coveralls.io/github/kalekundert/stack_alert?branch=master

Getting Started
===============
Install stack_alert using ``pip``::

    $ pip install stack_alert

Specify which questions you want to receive alerts for::

  $ vi ~/.config/stack_alert/config.toml
  [[query]]
  site = 'stackoverflow'
  tag = 'python'
  keywords = '(num|sci)py'  # regular expression
  recipient = 'alice@example.com'
  
Configure `cron` to call `stack_alert` at 5:00 PM every day::

  $ crontab -e
  0 17 * * * stack_alert
  
Log messages are written to stderr.  I recommend using `ts <http://joeyh.name/code/moreutils/>`__ and `tinylog <http://b0llix.net/perp/site.cgi?page=tinylog.8>`__ to collect and rotate these messages::

  $ crontab -e
  0 17 * * * stack_alert 2>&1 | ts | tinylog /path/to/log/dir

