# PushOverflow
[![PyPI](https://img.shields.io/pypi/v/pushoverflow)](https://pypi.org/project/pushoverflow/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pushoverflow)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/amcintosh/pushoverflow/run-tests.yml?branch=main)](https://github.com/amcintosh/pushoverflow/actions?query=workflow%3A%22Run+Tests%22)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/1cd16cda0531412c8cd6eee0c217688a)](https://app.codacy.com/gh/amcintosh/PushOverflow/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
Send Pushover notifications of new questions posted to StackExchange
## Installation
To install:
```shell
pip install pushoverflow
```
## Setup
- Copy and rename `pushoverflow.ini.sample` to `pushoverflow.ini`. By default PushOverflow will look
for the file in the current directory (eg. `./pushoverflow.ini`) or you can specify the path at runtime
(eg. `pushoverflow /path/to/pushoverflow.ini`).
- Edit the configuration for the StackExchange sites you would like notifications. `tags` allows you to
filter questions with one of those tags (comma separated tags treated as boolean OR). `exclude` will
filter out questions with any oof those tags. Both are optional.
Each configuration section will check a specific StackExchange site. For instance `[scifi]` will check
for new questions in http://scifi.stackexchange.com/ (Science Fiction & Fantasy).
- You will need to specify your Pushover user key in the configuration (in `userkey`), as well as
[register an application](https://pushover.net/api#registration) with Pushover and specify the
application's API token (in `appkey`).
- Set `time_delta_minutes` to the number of minutes you would like between each check.
- Setup a cron job (`crontab -e`) to run `pushoverflow.py` with the same frequency as `time_delta_minutes`.
Eg. For `time_delta_minutes = 20`:
```txt
*/20 * * * * pushoverflow /path/to/config_file
```
or
```txt
*/20 * * * * cd /path/to/config_directory && pushoverflow
```
### Future Ideas
- Allow boolean AND of multiple tags
- More granular priority settings
Raw data
{
"_id": null,
"home_page": "https://github.com/amcintosh/PushOverflow",
"name": "pushoverflow",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "stackexchange, pushover, notifications",
"author": "Andrew McIntosh",
"author_email": "andrew@amcintosh.net",
"download_url": "https://files.pythonhosted.org/packages/5c/c7/bce86dbfdb565ee363b2418dc38a7ef65e0f5854208ab4ca879bf6bb56c9/pushoverflow-2.0.1.tar.gz",
"platform": null,
"description": "# PushOverflow\n\n[![PyPI](https://img.shields.io/pypi/v/pushoverflow)](https://pypi.org/project/pushoverflow/)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pushoverflow)\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/amcintosh/pushoverflow/run-tests.yml?branch=main)](https://github.com/amcintosh/pushoverflow/actions?query=workflow%3A%22Run+Tests%22)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/1cd16cda0531412c8cd6eee0c217688a)](https://app.codacy.com/gh/amcintosh/PushOverflow/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)\n\nSend Pushover notifications of new questions posted to StackExchange\n\n## Installation\n\nTo install:\n\n```shell\npip install pushoverflow\n```\n\n## Setup\n\n- Copy and rename `pushoverflow.ini.sample` to `pushoverflow.ini`. By default PushOverflow will look\n for the file in the current directory (eg. `./pushoverflow.ini`) or you can specify the path at runtime\n (eg. `pushoverflow /path/to/pushoverflow.ini`).\n\n- Edit the configuration for the StackExchange sites you would like notifications. `tags` allows you to\n filter questions with one of those tags (comma separated tags treated as boolean OR). `exclude` will\n filter out questions with any oof those tags. Both are optional.\n\n Each configuration section will check a specific StackExchange site. For instance `[scifi]` will check\n for new questions in http://scifi.stackexchange.com/ (Science Fiction & Fantasy).\n\n- You will need to specify your Pushover user key in the configuration (in `userkey`), as well as\n [register an application](https://pushover.net/api#registration) with Pushover and specify the\n application's API token (in `appkey`).\n\n- Set `time_delta_minutes` to the number of minutes you would like between each check.\n\n- Setup a cron job (`crontab -e`) to run `pushoverflow.py` with the same frequency as `time_delta_minutes`.\n Eg. For `time_delta_minutes = 20`:\n\n ```txt\n */20 * * * * pushoverflow /path/to/config_file\n ```\n\n or\n\n ```txt\n */20 * * * * cd /path/to/config_directory && pushoverflow\n ```\n\n### Future Ideas\n\n- Allow boolean AND of multiple tags\n- More granular priority settings\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Pushover Notifications for StackExchange Sites",
"version": "2.0.1",
"project_urls": {
"Download": "https://github.com/amcintosh/PushOverflow/archive/refs/tags/2.0.1.tar.gz",
"Homepage": "https://github.com/amcintosh/PushOverflow"
},
"split_keywords": [
"stackexchange",
" pushover",
" notifications"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "320e19ce76143f285ef247ed9c629f0b1cebc9eca60ea9f9e7a8b2806df6d660",
"md5": "32c4f5d6108693a7c97cc151273fdd01",
"sha256": "8edc395d8f7254d46d2f5b9a8b701b0597cc1f079f4bc25d6ac5147c6c73f25b"
},
"downloads": -1,
"filename": "pushoverflow-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "32c4f5d6108693a7c97cc151273fdd01",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6816,
"upload_time": "2024-12-31T00:23:51",
"upload_time_iso_8601": "2024-12-31T00:23:51.631612Z",
"url": "https://files.pythonhosted.org/packages/32/0e/19ce76143f285ef247ed9c629f0b1cebc9eca60ea9f9e7a8b2806df6d660/pushoverflow-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5cc7bce86dbfdb565ee363b2418dc38a7ef65e0f5854208ab4ca879bf6bb56c9",
"md5": "5bb5b602952df87e4483ab453924af82",
"sha256": "3669ecffe0e2adc87308551f95613c45c94c3df0ba648ddcecc1050ae0927309"
},
"downloads": -1,
"filename": "pushoverflow-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "5bb5b602952df87e4483ab453924af82",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7846,
"upload_time": "2024-12-31T00:23:54",
"upload_time_iso_8601": "2024-12-31T00:23:54.375370Z",
"url": "https://files.pythonhosted.org/packages/5c/c7/bce86dbfdb565ee363b2418dc38a7ef65e0f5854208ab4ca879bf6bb56c9/pushoverflow-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-31 00:23:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "amcintosh",
"github_project": "PushOverflow",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "click",
"specs": [
[
"<",
"9.0"
]
]
},
{
"name": "requests",
"specs": [
[
"<",
"3.0"
]
]
}
],
"lcname": "pushoverflow"
}