JJKiers Agent
81fc63474f
This commit adds new documentation to enhance agent readiness within the repository: - `AGENTS.md`: Provides a high-level overview of the project's purpose, technical stack, key workflows, and repository structure. - `.agents/gitea_api.md`: Contains detailed instructions and examples for programmatic interaction with the Gitea API, covering operations like fetching and creating issues/pull requests, along with a quick reference of API capabilities. These additions aim to streamline future autonomous operations by centralizing essential repository knowledge and API usage guidelines. It replaces previous ad-hoc methods for interacting with Gitea.
Newsletter to Web
Converts a newsletter to and Atom feed and static HTML files.
Usage
Get the latest release from the releases page.
Getting help
For help, use
newsletter-to-web helpnewsletter-to-web help <subcommand>.
Basic usage
First, download all messages from the IMAP mail server
and store them in the data/ directory:
newsletter-to-web fetch-from-imap -s <imap.example.com> -u <email@example.com> -p <password>
Then, convert them to an Atom feed, using
newsletters.example.com as the base domain:
newsletter-to-web --include-html build-feed newsletters.example.org
This will put the output in the output/ directory. The Atom
feed will be in output/feed.xml, together with a very simple
index.html file pointing to the feed. It will also add an HTML
file for every email with the HTML content.
The feed will already contain the full HTML, so it can easily be read from a feed reader.
Features
Receive email
- IMAP integration
- Direct feeding of email message
- Read from Maildir
- Read from MBOX
Convert email to HTML
- Generate static HTML files
- Parse and add unsubscribe link
- Where possible: remove tracking pixels / images
- Prevent loading of scripts / images without user interaction
Create ATOM feed
- Single feed for everything
- One feed per newsletter
- Index feed (containing all newsletters)?