From e87dc38209d00af45841afc61a58be2ed05ff9cc Mon Sep 17 00:00:00 2001 From: github-actions Date: Tue, 14 Jul 2020 17:51:38 +0000 Subject: [PATCH 1/4] 0.1.0 Automatically generated by python-semantic-release --- stack_alert/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/stack_alert/__init__.py b/stack_alert/__init__.py index 06ff3d3..77b4b97 100644 --- a/stack_alert/__init__.py +++ b/stack_alert/__init__.py @@ -4,7 +4,7 @@ Be notified when interesting questions are posted to Stack Exchange sites. """ -__version__ = '0.0.0' +__version__ = '0.1.0' from .api import * From 3130c3a4434c82ceec7edf03dd9aadf2c75e38a7 Mon Sep 17 00:00:00 2001 From: Kale Kundert Date: Tue, 14 Jul 2020 14:27:56 -0400 Subject: [PATCH 2/4] docs: fix formatting error --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 94e6ca6..4151689 100644 --- a/README.rst +++ b/README.rst @@ -25,7 +25,7 @@ using regular expressions against the title and body of the question. Getting Started =============== -Install stack_alert using ``pip``:: +Install `stack_alert` using ``pip``:: $ pip install stack_alert From f33886278caef9f4d3d095e4fc4fc627d53dd476 Mon Sep 17 00:00:00 2001 From: Kale Kundert Date: Tue, 14 Jul 2020 14:28:32 -0400 Subject: [PATCH 3/4] docs: use restructured text syntax --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 4151689..8bb7e8a 100644 --- a/README.rst +++ b/README.rst @@ -25,7 +25,7 @@ using regular expressions against the title and body of the question. Getting Started =============== -Install `stack_alert` using ``pip``:: +Install ``stack_alert`` using ``pip``:: $ pip install stack_alert @@ -38,7 +38,7 @@ Specify which questions you want to receive alerts for:: keywords = '(num|sci)py' # regular expression recipient = 'alice@example.com' -Configure `cron` to call `stack_alert` at 5:00 PM every day:: +Configure `cron` to call ``stack_alert`` at 5:00 PM every day:: $ crontab -e 0 17 * * * stack_alert From 3c5858c01a4657b0fc9802629f4bdeb9e5a2a18b Mon Sep 17 00:00:00 2001 From: Kale Kundert Date: Fri, 17 Jul 2020 09:27:24 -0400 Subject: [PATCH 4/4] docs: describe how to configure $PATH in cron --- README.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 8bb7e8a..0d29861 100644 --- a/README.rst +++ b/README.rst @@ -25,8 +25,10 @@ using regular expressions against the title and body of the question. Getting Started =============== -Install ``stack_alert`` using ``pip``:: +Install ``stack_alert`` using ``pip``, preferably into a clean virtual environment:: + $ python -m venv ~/stack_alert_venv + $ ~/stack_alert_venv/bin/activate $ pip install stack_alert Specify which questions you want to receive alerts for:: @@ -38,12 +40,10 @@ Specify which questions you want to receive alerts for:: 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 `__ and `tinylog `__ to collect and rotate these messages:: +Configure `cron` to call ``stack_alert`` at 5:00 PM every day. Log messages are written to stderr. I recommend using `ts `__ and `tinylog `__ to collect and rotate these messages. Make sure that ``$PATH`` includes the ``stack_alert`` virtual environment, the aforementioned logging programs, and ``sendmail``:: + $ which sendmail + /usr/sbin/sendmail $ crontab -e + PATH=$HOME/stack_alert_venv/bin:/usr/sbin:/usr/bin:/bin 0 17 * * * stack_alert 2>&1 | ts | tinylog /path/to/log/dir