https://github.com/slott56/feederreader

RSS Feed Filter and Digest
https://github.com/slott56/feederreader

rss-reader uscourts

Last synced: 7 days ago
JSON representation

RSS Feed Filter and Digest

• Host: GitHub
• URL: https://github.com/slott56/feederreader
• Owner: slott56
• License: mit
• Created: 2023-12-28T19:04:43.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-01-11T16:57:29.000Z (10 months ago)
• Last Synced: 2024-01-12T02:10:52.339Z (10 months ago)
• Topics: rss-reader, uscourts
• Language: Python
• Homepage: https://slott56.github.io/FeederReader/_build/html/index.html
• Size: 300 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# RSS Feeder/Reader

This monitors and filters RSS feeds.

The focus is on AOUSC -- it specifically parses the title attribute of each `` to extract a Docket Number.

# Installation

Python >= 3.11 is required. 

Creating a virtual environment is strongly suggested.

Install Miniconda as one way to handle the install and environment management.

Tools like hatch and poetry also work well.

```bash

conda create --name feederreader python==3.11 

conda activate feederreader

python -m pip install -r requirements.txt

```

If you want the SMTP notifier, you need to configure it.

# Test

Testing uses ``tox``

```bash

tox

```

# Operation

There are four separate parts:

-   Cleaning,

-   Reading,

-   Filtering, and

-   Writing.

The cleaner removes cache files older the 90 days.

The reader scans the RSS feeds and updates the cache files with new items.

The filter scans the cache files for specific dockets, and updates a cache of items with those docket numbers.

The writer creates a static HTML web site with indices organized by court, docket, and date.

A `config.toml` file has the congiguation

```toml

[cleaner]

    days_ago = 90

[reader]

    base_directory = "data"

    feeds = [

        "https://ecf.dcd.uscourts.gov/cgi-bin/rss_outside.pl",

        "https://ecf.nyed.uscourts.gov/cgi-bin/readyDockets.pl",

        ## "https://ecf.cacd.uscourts.gov/cgi-bin/rss_outside.pl",

        ## "https://ecf.nysd.uscourts.gov/cgi-bin/rss_outside.pl",

    ]

[filter]

    dockets = ["16-cv-07161", "16-cv-01557", "18-cv-00979", "17-cv-06331-ARR-CLP"]

[writer]

    format = "html"  # Or md or csv

    page_size = 20

    base_directory = "output"

[monitor]

    every = ["10:00", "22:00"]

```

The `data` and `output` directories *must* exist before running any of the programs.

The app does *not* create these two top-level directories.

Put the credentials in your personal home directory.

Use the name ``~/fdrdr_config.toml``

```toml

[notifier.smtp]

    host = "smtp.your host"

    port = 587

    admin = "[email protected] host"

    password = "password"

    send_to = "[email protected]"

```

Be sure to protect this file so it's only readable by you.

```bash

chmod 600 ~/fdrdr_config.toml

```

You can set ``FDRDR_CREDENTIALS``

to use another directory instead of your personal

home directory.

This command runs the internal schedule:

```bash

python src/monitor.py

```

The terminal window can then be ignored.

Use **Control-C** to stop it.