https://github.com/EscherMoore/DitchTheBell Skip to content Toggle navigation Sign up * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code Explore + All features + Documentation + GitHub Skills + Blog * Solutions For + Enterprise + Teams + Startups + Education By Solution + CI/CD & Automation + DevOps + DevSecOps Resources + Learning Pathways + White papers, Ebooks, Webinars + Customer Stories + Partners * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Pricing Search or jump to... Search code, repositories, users, issues, pull requests... Search [ ] Clear Search syntax tips Provide feedback We read every piece of feedback, and take your input very seriously. [ ] [ ] Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quickly Name [ ] Query [ ] To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert {{ message }} EscherMoore / DitchTheBell Public * Notifications * Fork 0 * Star 9 A highly configurable Linux-based desktop notifier for RSS/Atom feeds. pypi.org/project/dtbell/ License GPL-3.0 license 9 stars 0 forks Activity Star Notifications * Code * Issues 0 * Pull requests 0 * Actions * Projects 0 * Security * Insights More * Code * Issues * Pull requests * Actions * Projects * Security * Insights EscherMoore/DitchTheBell This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. main Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags Name already in use A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch? Cancel Create 1 branch 3 tags Code * Local * Codespaces * Clone HTTPS GitHub CLI [https://github.com/E] Use Git or checkout with SVN using the web URL. [gh repo clone Escher] Work fast with our official CLI. Learn more about the CLI. * Open with GitHub Desktop * Download ZIP Sign In Required Please sign in to use Codespaces. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching Xcode If nothing happens, download Xcode and try again. Launching Visual Studio Code Your codespace will open once ready. There was a problem preparing your codespace, please try again. Latest commit @EscherMoore EscherMoore Update PyPI link in README to point directly to project ... b6715f8 Sep 25, 2023 Update PyPI link in README to point directly to project b6715f8 Git stats * 11 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time src/dtbell fix: Move _ensure_connection for compatibility September 25, 2023 11:42 .gitignore Initial commit, release version 1.0.0 September 24, 2023 17:03 LICENSE Initial commit, release version 1.0.0 September 24, 2023 17:03 README.md Update PyPI link in README to point directly to project September 25, 2023 12:28 logo.png Use a smaller logo on the README for faster loading speed September 24, 2023 20:06 pyproject.toml Release version 1.0.2 September 25, 2023 11:52 requirements.txt Initial commit, release version 1.0.0 September 24, 2023 17:03 View code [ ] Ditch The Bell Features Install Dependencies: Usage Configuring File Locations Adding Feeds Configuration Options Feed Configuration Defining Profiles Adding Profiles to URLs Contributing License README.md Ditch The Bell Logo A desktop notifier for RSS/Atom feeds that lets you closely configure features of the freedesktop notification specification to unlock the most customizable feed notification experience possible on Linux. Features * Configure a custom command to launch when clicking on a notification (e.g., your favorite application, shell command, custom script). The feed entry link will be passed as an argument, allowing the command to open the link directly. * A feed profile system built to separate notification behaviors for each of your different types of feeds (e.g., news, blogs, podcasts, videos, etc). * Configuration options to fine-tune feed fetching behavior such as the search window, search interval, etc. Install Dependencies: * Python 3.7+ * Optional: Before installing, it is recommended that you install PyGObject from your distribution's package manager for GObject Introspection. The package is typically named one of the following: python-gi, python-gobject, or pygobject on most distributions. Ditch The Bell is available on PyPI and can be installed via pip, the Python package manager. pip install dtbell Usage To run, simply execute: dtbell If needed, use the --debug flag to print debug logs to the console: dtbell --debug Configuring File Locations All relevant files are stored in accordance with the XDG Base Directory Specification. Configuration files config.ini, urls: are located in $XDG_CONFIG_HOME /dtbell/. If $XDG_CONFIG_HOME is not set, the default location is $HOME /.config/dtbell/. Data files dtbell.db, dtbell.log: are located in $XDG_DATA_HOME/ dtbell/. If $XDG_DATA_HOME is not set, the default location is $HOME /.local/share/dtbell/. If you enable thumbnail downloads, thumbnails will be temporarily downloaded to /tmp/dtbell/. Adding Feeds To add feeds, edit the urls file, adding one URL per line. https://example.com/feed/rss.xml https://another-example.com/feed/rss.xml Authenticated feeds are not yet supported. Configuration Options To modify the configuration settings, edit the config.ini file. Feed Configuration The [feed] section in your config.ini file serves as the primary area for defining feed fetch behavior. Below are the available configuration options for the [feed] section: Name Description Data Default Type Value The number of days to go back when search_window searching for new feeds. Cached Integer 1 entries are retained for this duration. search_interval Time interval (in minutes) between Integer 30 each search for new entries. search_on_startup Determines if a search is initiated Boolean true upon application launch. Maximum number of notifications to flood_cap avoid notification flooding. Set to Integer 10 0 for unlimited. Maximum time (in seconds) the app fetch_timeout will wait for a response after Integer 10 requesting a feed. Defining Profiles The profile system is designed to adapt to the diverse array of feeds that modern RSS users often manage (news feeds, blog feeds, podcast feeds, etc). It allows for tailored notification behavior based on the nature of each feed. You can define custom notification profiles for these specific types of feeds in your config.ini file. For instance, a profile for video based feeds could look like this: [video] entry_age = true persist_on_click = true launcher = mpv launcher_args = '--save-position-on-quit' A [default] profile is defined in the config.ini file and serves as the baseline configuration for all feeds not tagged with a custom profile. Below are the available configuration options for the [default] section: Name Description Data Default Value Type Shell command to open launcher notifications; must String default_browser accept a URL as argument. Argument(s) to pass to launch_args launcher; e.g., '-P news' String '' if launcher was set to firefox. Determines whether transience notifications are Boolean false temporary and disappear after a short time. Keep notification after persist_on_click click; useful if Boolean false transience is set to false. Notification urgency: 0 urgency (low), 1 (normal), 2 Integer 1 (critical). Timeout in ms; -1 for timeout server default, 0 for Integer -1 never. entry_age Display entry age. Boolean false Download thumbnails; download_thumbnails consult your feed's TOS Boolean true and be mindful of bandwidth usage. You can modify the default profile directly to affect all untagged feeds, or define custom profiles like the [video] profile if you wish to customize settings for a select group of feeds. Omitting fields in a custom profile will cause those settings to fall back to the values defined in the default profile. Adding Profiles to URLs As mentioned earlier, the urls file should contain one RSS feed URL per line. To associate a profile with a specific feed, simply append the profile name (the name within the square brackets [ ] in your config.ini) to the end of the feed URL, separated by a space. The format is simply url profile. For instance, using the [video] profile from earlier, an example urls file would look like this: https://example.com/feed/rss.xml video https://another-example.com/feed/rss.xml video Contributing This program is in its early stages of development and may have some rough edges or bugs. If you encounter any issues and want to contribute, feel free to submit an issue or open a PR! Note: All PRs must adhere to PEP 8 and pass pylint checks. License This program is licensed under the GPLv3; see the LICENSE file. About A highly configurable Linux-based desktop notifier for RSS/Atom feeds. pypi.org/project/dtbell/ Resources Readme License GPL-3.0 license Activity Stars 9 stars Watchers 1 watching Forks 0 forks Report repository Releases 2 v1.0.2 Latest Sep 25, 2023 + 1 release Packages 0 No packages published Languages * Python 100.0% Footer (c) 2023 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time.