commit bb17e55b3e22706505e42e38616917b95038b181
parent b5fa9c10a8254da3eb619d4ef337a2e3a7cd5cf1
Author: Thorsten Ortlepp <post@ortlepp.eu>
Date: Wed, 30 Mar 2022 15:45:57 +0200
Another update for project feedgenerator
Diffstat:
2 files changed, 10 insertions(+), 20 deletions(-)
diff --git a/content/de/projekte/feedgenerator.md b/content/de/projekte/feedgenerator.md
@@ -2,7 +2,7 @@
title: "feedgenerator"
description: "Ein einfaches Werkzeug um verschiedene Feeds zu erzeugen"
date: 2022-02-01T20:10:00+01:00
-lastmod: 2022-03-23T23:25:00+01:00
+lastmod: 2022-03-30T15:40:00+02:00
draft: false
translationKey: projects-feedgenerator
xxbreadcrumbshow: novalue
@@ -27,20 +27,19 @@ feedgenerator liest Webseiten und bestehende Newsfeeds aus und erzeugt aus deren
feedgenerator wurde in Python programmiert. Der Quellcode kann aus dem [öffentlichen Git-Repository](https://git.ortlepp.eu/web/feedgenerator/) heruntergeladen werden. Für die Entwicklung wird ein möglichst aktuelles Python 3 benötigt. Abhängigkeiten sind in der Datei *requirements.txt* hinterlegt.
-Ich verwende [zipapp](https://docs.python.org/3/library/zipapp.html), um feedgenerator zu bauen und auf meinem Server zu deployen. Der Build erfolgt in drei Schritten:
+Ich verwende [zipapp](https://docs.python.org/3/library/zipapp.html), um feedgenerator zu bauen und auf meinem Server zu deployen. Der Build erfolgt in vier Schritten:
```
git clone https://git.ortlepp.eu/feedgenerator.git/
-pip3 install -r feedgenerator/requirements.txt --target feedgenerator/
+cd feedgenerator
+pip3 install --upgrade -r requirements.txt --target feedgenerator/
python3 -m zipapp feedgenerator/
```
## Verwendung
-Vor dem Build kann in der Datei *\_\_main\_\_.py* festgelegt werden, unter welchem Pfad und Dateiname Feeds gespeichert werden sollen. Außerdem kann festgelegt werden, wie viele Einträge die erstellten Feeds beinhalten sollen.
-
-Wurde das Tool wie im Abschnitt *Entwicklung* beschrieben gebaut, kann es einfach mit `python3 feedgenerator.pyz` ausgeführt werden.
+Wurde das Tool wie im Abschnitt *Entwicklung* beschrieben gebaut, kann es einfach mit `python3 feedgenerator.pyz` ausgeführt werden. Im selben Verzeichnis kann eine Datei *feedgenerator.ini* abgelegt werden, über welche dann der Dateiname der Feeds, die Anzahl der Einträge pro Feed und Inhaltsfilter konfiguriert werden können. Eine Beispielkonfiguration ist im Git-Repository enthalten.
Die von feedgenerator erzeugten Feeds werden lokal als XML-Dateien gespeichert. Sinnvoll ist ein zum Beispiel stündlich ausgeführter [Cronjob](https://de.wikipedia.org/wiki/Cron), welcher die Feeddateien regelmäßig mit den aktuellsten Inhalten neu generiert.
@@ -49,8 +48,4 @@ Die von feedgenerator erzeugten Feeds werden lokal als XML-Dateien gespeichert.
Es ist geplant, noch weitere Funktionen zu implementieren. Aktuell geplante Features:
-- [X] Konfiguration auslagern in eigene ~~Datei~~ Klasse
-- [X] Feed für Deutschlandfunk Nachrichten implementieren
-- [X] Feed für Heise Online implementieren
-- [ ] Konfiguration auslagern
- [ ] Feed für Twitter-Profile implementieren
diff --git a/content/en/projects/feedgenerator.md b/content/en/projects/feedgenerator.md
@@ -2,7 +2,7 @@
title: "feedgenerator"
description: "A simple tool to create various feeds"
date: 2022-02-01T20:10:00+01:00
-lastmod: 2022-03-23T23:25:00+01:00
+lastmod: 2022-03-30T15:40:00+02:00
draft: false
translationKey: projects-feedgenerator
xxbreadcrumbshow: novalue
@@ -27,20 +27,19 @@ feedgenerator reads websites and existing news feeds and creates news feeds in [
feedgenerator is written in Python. The source code can be downloaded from the [public Git repository](https://git.ortlepp.eu/web/feedgenerator/). For development you need a recent version of Python 3. Requirements are documented in *requirements.txt*.
-I use [zipapp](https://docs.python.org/3/library/zipapp.html) to build and deploy feedgenerator to my server. The build is done in three easy steps:
+I use [zipapp](https://docs.python.org/3/library/zipapp.html) to build and deploy feedgenerator to my server. The build is done in four easy steps:
```
git clone https://git.ortlepp.eu/feedgenerator.git/
-pip3 install -r feedgenerator/requirements.txt --target feedgenerator/
+cd feedgenerator
+pip3 install --upgrade -r requirements.txt --target feedgenerator/
python3 -m zipapp feedgenerator/
```
## Usage
-Configuration can be done before build in the file *\_\_main\_\_.py*. There are options for the path and filenames of the generated feeds. Also, the number of entries in the generated feeds can be specified.
-
-If the tool was built as stated in the *Development* section, you can run it by simply calling `python3 feedgenerator.pyz`.
+If the tool was built as stated in the *Development* section, you can run it by simply calling `python3 feedgenerator.pyz`. You can place a file *feedgenerator.ini* in the same directory. In this file you can configure the filenames of the feeds, the number of entries in the feeds and the content filters. The Git repository contains a sample configuration file.
The feeds created by feedgenerator are stored as XML files on local disc. It is a good idea to set up an hourly [cron job](https://en.wikipedia.org/wiki/Cron) to re-create the feed files regularly with to most recent content.
@@ -49,8 +48,4 @@ The feeds created by feedgenerator are stored as XML files on local disc. It is
My plan is to implement some more features. Currently planned features are:
-- [X] Externalize configuration into a dedicated ~~file~~ class
-- [X] Implement a feed for Deutschlandfunk Nachrichten
-- [X] Implement a feed for Heise Online
-- [ ] Externalize configuration
- [ ] Implement a feed for Twitter profiles
