Newsletter Generator - Anleitung

🚀 Über den Newsletter Generator

Der Newsletter Generator automatisiert die Erstellung von Newslettern aus Ihren Beiträgen und Events. Er scannt Ihre _beitraege/ und _data/events.yml und erstellt professionelle Newsletter-HTML-Dateien mit:

🛠️ Installation & Setup

1. Virtual Environment erstellen (empfohlen)

# Im Website-Verzeichnis
python3 -m venv newsletter-env

# Environment aktivieren
source newsletter-env/bin/activate  # Linux/Mac
# oder
newsletter-env\Scripts\activate     # Windows

2. Python Dependencies installieren

# Im aktivierten Virtual Environment
pip install PyYAML

# Oder mit requirements.txt
pip install -r requirements.txt

3. Script ausführbar machen (Linux/Mac)

chmod +x newsletter-generator.py

4. Erste Verwendung testen

# Mit Virtual Environment
source newsletter-env/bin/activate
python newsletter-generator.py --help

# Ohne Virtual Environment (falls PyYAML global installiert)
python newsletter-generator.py --help

📧 Newsletter erstellen

Workflow Übersicht:

  1. Virtual Environment aktivieren (falls verwendet)
  2. Script starten mit gewünschten Optionen
  3. Beiträge auswählen aus der interaktiven Liste
  4. Newsletter wird generiert und gespeichert
  5. HTML-Datei verwenden in Ihrem Newsletter-Tool

Einfache Nutzung:

# Environment aktivieren (falls verwendet)
source newsletter-env/bin/activate

# Newsletter erstellen
python newsletter-generator.py

# Environment deaktivieren
deactivate

Mit Optionen:

# Beiträge der letzten 60 Tage berücksichtigen
python newsletter-generator.py --since-days 60

# Anderes Website-Verzeichnis
python newsletter-generator.py --base-path /pfad/zu/website/

# Kombination beider Optionen
python newsletter-generator.py --since-days 90 --base-path /pfad/zu/website/

🎯 Workflow im Detail

1. Script starten

$ source newsletter-env/bin/activate  # Falls Virtual Environment verwendet
$ python newsletter-generator.py
🚀 OIC Newsletter Generator
========================================
📁 Lade Beiträge...
✅ 8 Beiträge gefunden
📅 Lade Events...
✅ 2 kommende Events gefunden
🗓️  Suche Beiträge seit: 01.06.2024
✅ 3 aktuelle Beiträge gefunden

2. Beiträge auswählen

📄 Verfügbare Beiträge (3):
============================================================
[ 1] KI-Tool revolutioniert die Bürgerbeteiligung
     📅 30.06.2024 | 👤 Stephan Berkowitz | 🏷️ Tools
     💭 Ein innovatives KI-Tool unterstützt die Stadt Bielefeld dabei...

[ 2] Smart City Projekt gestartet  
     📅 15.06.2024 | 👤 Maria Gonçalves | 🏷️ Projekte
     💭 Neues Pilotprojekt zur intelligenten Stadtentwicklung...

[ 3] Innovation Workshop Rückblick
     📅 10.06.2024 | 👤 Sarah Bollmann | 🏷️ Events
     💭 Erfolgreicher Workshop mit 50 Teilnehmern...

Auswahl-Optionen:
• Einzelne Nummern: 1,3,5
• Bereiche: 1-3  
• Alle: 'all' oder 'alle'
• Keine: 'none' oder Enter

➤ Beiträge auswählen: 1,3

3. Newsletter wird generiert

✅ 2 Beiträge ausgewählt:
   • KI-Tool revolutioniert die Bürgerbeteiligung
   • Innovation Workshop Rückblick

🔄 Generiere Newsletter mit 2 Beiträgen und 2 Events...

✅ Newsletter erfolgreich generiert!
📄 Datei: generated-newsletters/newsletter-2024-06.html
🌐 Pfad: newsletter-2024-06.html

💡 Tipp: Öffnen Sie die Datei in einem Browser zur Vorschau
💡 Oder kopieren Sie die HTML-Datei in Ihr Newsletter-Tool

4. Environment deaktivieren

$ deactivate  # Falls Virtual Environment verwendet wurde

📋 Auswahl-Syntaxen

Eingabe Bedeutung
1 Beitrag Nr. 1
1,3,5 Beiträge Nr. 1, 3 und 5
1-3 Beiträge Nr. 1 bis 3
1,3-5,7 Beitrag 1, Beiträge 3-5, Beitrag 7
all oder alle Alle verfügbaren Beiträge
none oder Enter Keine Auswahl, Abbruch

🎨 Was wird generiert?

Newsletter-Struktur:

  1. Header mit OIC-Branding und aktuellem Datum
  2. Einleitung mit Begrüßung und Zusammenfassung
  3. Beitrags-Abschnitte mit:
    • Titel des Beitrags
    • Anreißertext (teaser)
    • “Beitrag lesen” Button mit Link
    • Meta-Infos (Datum, Autor, Kategorie)
  4. Abschluss mit Verabschiedung
  5. Footer mit Kontaktdaten und Abmelde-Link

Beispiel-Output:

<!-- Automatisch generiert: -->
<h3>KI-Tool revolutioniert die Bürgerbeteiligung</h3>
<p>Ein innovatives KI-Tool unterstützt die Stadt Bielefeld dabei, 
   Bürgerfeedback effizienter zu sammeln und auszuwerten...</p>
<a href="https://oic-bielefeld.de/beitraege/beispiel-ki-tool/">
   Beitrag lesen
</a>
<p>📅 30.06.2024 | 👤 Stephan Berkowitz | 🏷️ Tools</p>

📁 Ausgabe-Dateien

Datei-Pfad:

generated-newsletters/newsletter-YYYY-MM.html

Datei-Namen:

⚙️ Konfiguration

Command-Line Optionen:

python newsletter-generator.py --help

optional arguments:
  -h, --help           show this help message and exit
  --since-days DAYS    Beiträge der letzten N Tage (Standard: 30)
  --base-path PATH     Basis-Pfad der Jekyll-Website (Standard: .)

Beispiele:

# Nur Beiträge der letzten Woche
python newsletter-generator.py --since-days 7

# Beiträge der letzten 3 Monate  
python newsletter-generator.py --since-days 90

# Andere Website
python newsletter-generator.py --base-path /pfad/zu/anderer/website/

🔧 Anpassungen

Newsletter-Template ändern:

Das Script nutzt newsletter-template.html. Änderungen dort wirken sich direkt auf die Ausgabe aus.

Datum-Format anpassen:

# In newsletter-generator.py, Zeile ~180
date_str = post['date_obj'].strftime('%d.%m.%Y')  # Deutsch
# oder
date_str = post['date_obj'].strftime('%Y-%m-%d')  # ISO-Format

Intro-Text anpassen:

# In generate_newsletter_content(), Zeile ~230
intro_text = f"""
Ihr individueller Begrüßungstext hier...
"""

🐛 Troubleshooting

Häufige Probleme:

Problem: ModuleNotFoundError: No module named 'yaml' Lösung:

# Mit Virtual Environment (empfohlen)
source newsletter-env/bin/activate
pip install PyYAML

# Oder global (nicht empfohlen)
pip install --user PyYAML

Problem: Keine Beiträge gefunden Lösung:

Problem: Keine Events gefunden Lösung:

Problem: Ungültige YAML Syntax Lösung:

Problem: Template nicht gefunden Lösung:

Problem: Permission denied beim Erstellen des Output-Verzeichnisses Lösung:

Debug-Modus:

# Am Anfang von newsletter-generator.py hinzufügen:
import logging
logging.basicConfig(level=logging.DEBUG)

🚀 Erweiterte Nutzung

1. Integration in Jekyll Build

# In Ihrem Build-Script
source newsletter-env/bin/activate
python newsletter-generator.py --since-days 30
deactivate
bundle exec jekyll build

2. Automatisierung mit Cron

# Wöchentlicher Newsletter (crontab -e)
0 9 * * 1 cd /pfad/zu/website && source newsletter-env/bin/activate && python newsletter-generator.py --since-days 7 && deactivate

3. Integration mit GitHub Actions

# .github/workflows/newsletter.yml
name: Generate Newsletter
on:
  workflow_dispatch:  # Manual trigger
jobs:
  newsletter:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Setup Python
      uses: actions/setup-python@v4
      with:
        python-version: '3.9'
    - name: Install dependencies
      run: pip install -r requirements.txt
    - name: Generate Newsletter
      run: python newsletter-generator.py --since-days 30

📈 Weitere Features (Erweiterungen)

Mögliche Erweiterungen:

📋 Checkliste für den ersten Newsletter

Setup-Checkliste:

Newsletter-Erstellung:

Viel Erfolg mit Ihrem automatisierten Newsletter! 📧

Bei Problemen oder Verbesserungsvorschlägen erstellen Sie gerne ein Issue im Repository.