Skip to main content

versions pypi

chakula is a Python library and command-line rss feed monitor with behavior similar to tail -f. chakula is based off of rsstail.py, but can be used as a library to call a custom function each time new entries appear in the feed.

Usage

$ chakula --help
positional arguments:
  urls                  The urls to tail (default: reads from stdin).

optional arguments:
  -h, --help            show this help message and exit
  -i INTERVAL, --interval INTERVAL
                        Number of seconds between polling (default: 300s).
  -N ITERATIONS, --iterations ITERATIONS
                        Number of times to poll before quiting (default: inf).
  -I INITIAL, --initial INITIAL
                        Number of entries to show (default: all)
  -n DATE, --newer DATE
                        Date by which entries should be newer than
  -s FIELD, --show FIELD
                        Entry field to display (default: title).
  -t FORMAT, --time-format FORMAT
                        The date/time format (default: 'YYYY/MM/DD HH:MM:SS').
  -F FORMAT, --format FORMAT
                        The output format (overrides other format options).
  -c CACHE, --cache CACHE
                        File path to store feed information across multiple runs.
  -r, --reverse         Show entries in reverse order.
  -f, --fail            Exit on error.
  -u, --unique          Skip duplicate entries.
  -H, --heading         Show field headings.
  -v, --version         Show version and exit.
  -V, --verbose         Increase output verbosity.

Format specifiers must have one the following forms:
  %(placeholder)[flags]s
  {placeholder:flags}

Examples:
  chakula <url>
  echo '<url>' | chakula --reverse
  chakula -s pubdate -s title -s author <url1> <url2> <url3>
  chakula --interval 60s --newer "2011/12/20 23:50:12" <url>
  chakula --format '%(timestamp)-30s %(title)s\n' <url>
  chakula --format '%(title)s was written on %(pubdate)s\n' <url>
  chakula --format '{timestamp:<30} {title} {author}\n' <url>
  chakula --format '{timestamp:<20} {pubdate:^30} {author:>30}\n' <url>
  chakula --time-format '%Y/%m/%d %H:%M:%S' <url>
  chakula --time-format 'Day of the year: %j Month: %b' <url>

Useful flags in this context are:
  %(placeholder)-10s - left align and pad
  %(placeholder)10s  - right align and pad
  {placeholder:<10}  - left align and pad
  {placeholder:>10}  - right align and pad
  {placeholder:^10}  - center align and pad

Available fields: author, comments, created, desc, description,
expired, id, link, pubdate, timestamp, title, updated, url

Installing

The latest stable version of chakula can be installed from pypi:

$ pip install chakula

Similar projects

License

chakula is released under the terms of the Revised BSD License.

Metadata

Release files for chakula 0.8.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for chakula 0.8.0
File Size Uploaded
chakula-0.8.0.tar.gz 27.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for chakula 0.8.0
File Interpreter ABI Platform
chakula-0.8.0-py3-none-any.whl Python 3 none any Details

Total release size: 40.0 kB

Release files / chakula-0.8.0.tar.gz

Download URL chakula-0.8.0.tar.gz
Size 27.4 kB
Tags Source
SHA-256 checksum
How to use checksums
6c6f9a3c8427dfa7990ffbcbd7cdcdbaefd1ab9ca2592f7dbb695b588f70b9b3
BLAKE2b-256 checksum
How to use checksums
ee71cda271f7214270d455341f502fd4083248afec444c37c60c31d1eea7dc9c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / chakula-0.8.0-py3-none-any.whl

Download URL chakula-0.8.0-py3-none-any.whl
Size 12.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
608c022856abe1c708af1ee1ad924b3d0ee44ce5d704a9c88fb7de465e05373e
BLAKE2b-256 checksum
How to use checksums
405f4257993b1ce6ba61bf7750519db55b8ec483f9aa4f859789216dabe0c0ad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.8.0 This release

2 release files

0.7.4

2 release files

0.7.3

2 release files

0.7.2

2 release files

0.7.1

2 release files

0.7.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page