Skip to main content

Creates a complete full text historical archive for an RSS or ATOM feed.

Project description

history4feed

codecov

Before you begin...

We use history4feed in the web version of Obstracts which includes many additional features over those in this codebase. You can find out more about the web version here.

Overview

It is common for feeds (RSS or XML) to only include a limited number of posts. I generally see the latest 3 - 5 posts of a blog in a feed. For blogs that have been operating for years, this means potentially thousands of posts are missed.

There is no way to page through historic articles using an RSS or ATOM feed (they were not designed for this), which means the first poll of the feed will only contain the limited number of articles in the feed. This limit is defined by the blog owner.

history4feed can be used to create a complete history for a blog and output it as an RSS feed.

history4feed offers an API interface that;

  1. takes an RSS / ATOM feed URL
  2. downloads a Wayback Machine archive for the feed
  3. identified all unique blog posts in the historic feeds downloaded
  4. downloads a HTML version of the article content on each page
  5. stores the post record in the databases
  6. exposes the posts as JSON or XML RSS

Install

Download and configure

# clone the latest code
git clone https://github.com/muchdogesec/history4feed

Configuration options

history4feed has various settings that are defined in an .env file.

To create a template for the file:

cp .env.example .env

To see more information about how to set the variables, and what they do, read the .env.markdown file.

Build the Docker Image

sudo docker compose build

Start the server

sudo docker compose up

Access the server

The webserver (Django) should now be running on: http://127.0.0.1:8002/

You can access the Swagger UI for the API in a browser at: http://127.0.0.1:8002/api/schema/swagger-ui/

Useful supporting tools

Support

Minimal support provided via the DOGESEC community.

License

Apache 2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

history4feed-1.2.6.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

history4feed-1.2.6-py3-none-any.whl (50.7 kB view details)

Uploaded Python 3

File details

Details for the file history4feed-1.2.6.tar.gz.

File metadata

  • Download URL: history4feed-1.2.6.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for history4feed-1.2.6.tar.gz
Algorithm Hash digest
SHA256 d3a271ff45cf5db0edcdae9c03ec950b62508a9bbf4a31980809d06d9d53ea1a
MD5 9bf8069aa61afc5b2d48a83ca1eecc06
BLAKE2b-256 d2517d671b340adf50af162fb9e4f69f37f7cada18c251a8b4e18a39e8024e61

See more details on using hashes here.

Provenance

The following attestation bundles were made for history4feed-1.2.6.tar.gz:

Publisher: create-release.yml on muchdogesec/history4feed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file history4feed-1.2.6-py3-none-any.whl.

File metadata

  • Download URL: history4feed-1.2.6-py3-none-any.whl
  • Upload date:
  • Size: 50.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for history4feed-1.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3d58626d255687e41b147d0f775238973639427a6a891ddf3073a21927793e3c
MD5 7a9699f255777c3e14837113632de6b3
BLAKE2b-256 95ffc9b1a550562cded1cc99772521d7864328514eb3c312f5fd81100a41c6a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for history4feed-1.2.6-py3-none-any.whl:

Publisher: create-release.yml on muchdogesec/history4feed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page