https://github.com/capjamesg/web-reader

A minimal web reader.
https://github.com/capjamesg/web-reader

atom feed-reader rss social-reader web-reader

Last synced: 3 months ago
JSON representation

A minimal web reader.

• Host: GitHub
• URL: https://github.com/capjamesg/web-reader
• Owner: capjamesg
• License: mit
• Created: 2024-06-29T15:48:38.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-09-18T20:33:36.000Z (4 months ago)
• Last Synced: 2024-10-06T08:41:04.285Z (4 months ago)
• Topics: atom, feed-reader, rss, social-reader, web-reader
• Language: Python
• Homepage:
• Size: 22.5 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# Web Reader

A minimal web reader for following web feeds.

This project is intentionally not designed to be a real-time reader. Rather, it is designed to retrieve content in intervals (i.e. every hour, every day).

Web Reader supports the following feed formats:

- RSS

- Atom

- JSON Feed

- microformats2

Only posts published in the last two days will be displayed in the feed reader.

## Installation

First, clone this repository and install the required dependencies:

```

git clone https://github.com/capjamesg/web-reader

cd web-reader

pip install -r requirements.txt

```

Then, update `feeds.txt` with the URLs of the feeds you want to follow.

Every feed should be on its own line in `feeds.txt`.

To poll for new posts, run:

```

python3 poll.py

```

To generate a site from the posts, run:

```

aurora build

```

Your feed will be available at `_site/index.html`.

This project uses the [Aurora](https://github.com/capjamesg/aurora) static site generator to generate web pagea. You can customise the site to your requirements. Reference material for Aurora is available on the [Aurora documentation website](https://aurora.jamesg.blog).

## License

This project is licensed under an [MIT license](LICENSE).