Der @ChaosPrinter.

18 04 2013

Wer mir auf Twitter folgt, hat es eventuell schon mit bekommen. Ich habe mal wieder etwas gebastelt. Den @chaosprinter.
Was verbirgt sich dahinter? Ein Thermodrucker, den meisten als Kassenbondrucker bekannt, angeschlossen an einen Raspberry Pi, zur Ausgabe von allem was mir so in den Sinn kommt. Wenn ihr eine Mention an @chaosprinter schreibt, wird sie automatisch ausgedruckt. Ihr könnt es gerne ausprobieren.

tl;dr

Wie kam ich auf die Idee?
Als Knirps war ich in den Ferien hin und wieder mit meinem Paps unterwegs bei ihm auf der Arbeit. Er hat Rohrpost- und Schienenförderanlagen gebaut und gewartet. Die Zentralen dieser Anlagen hatten einen „Fehlerspeicher“ – nicht wie heute in ein paar Speicherchips sondern auf Papier. Speicher war damals viel zu teuer und so hat man einen Thermodrucker eingebaut. Allerdings auch nur eine Sparversion. Das Papier wurde auf einen Metallwinkel gefädelt, vor die Thermozeile gespannt und von einen kleinen Motor wurde das Papier befördert. So konnte man auch nach Wochen noch sehen, wann mal ein Fehler passierte – natürlich nur, wenn Papier eingelegt war.
Solch eine Druckereinheit hatte ich in meinem Bastelfundus – allerdings ist alles in Epoxid vergossen, da kommt man also nicht dran. 

Ein wenig in der Bucht suchen und einige verlorene Auktionen später hab ich dann den Chaosprinter erstanden. Es ist ein Star TSP700 der ersten Generation, mit serieller Schnittstelle. Das Netzteil hat etwas mehr Leistung, schließlich brauch der Drucker bei 24 Volt Spannung knappe 2 Ampere unter Volllast.
Der Drucker hat zwei grundlegende Betriebsarten: „ESC/POS“ und „STAR Line“.

ESC/POS ist ein Standard von Epson, dieser vereinheitlicht die Kommunikation mit POS (Point of Sale) Druckern. Für diesen Modus gibt es auch schon fertige Bibliotheken die man nutzen kann. Doch leider ist der Funktionsumfang im ESC/POS Modus stark eingeschränkt, der Drucker ist nicht mehr der Neuste und unterstützt nur einige Grundfunktionen des Standards.
Der STAR Line genannte Modus ist ein proprietärer Modus von Star, den auch nur 2 Drucker unterstützen. Dafür ist er aber sehr gut dokumentiert und sehr einfach umzusetzen.

Angeschlossen habe ich den Drucker mit einem seriell-USB-Wandler, da der interne serielle Anschluss meines Raspberry Pi bereits mit einem RFID-Reader belegt ist. Die Kommunikation übernimmt eine kleine selbst geschriebene Python-Klasse mit aktuell nicht einmal 200 Zeilen.
Wer sich schon einmal mit den ASCII-Zeichen kleiner 32 befasst hat, dem fällt die Kommunikation mit dem Drucker leicht. Nahezu alle Befehle werden mit „Escape“, ASCII-Zeichen 27 / 0x1B, eingeleitet.
Wenn numerische Parameter, wie z.B. Seitenränder, gesetzt werden müssen, so kann hier die Zahl als Byte-Wert oder als ASCII-Zeichen gesendet werden. Also beispielsweise eine 1 oder „1“ (ASCII 49 / 0x31). Ich nutze in meinem Skript immer den Bytewert, dies funktioniert zuverlässiger als das entsprechende Zeichen.

Es ist auch möglich Grafiken zu drucken. Dazu gibt es zwei Auflösungen, „normal“ und „fine“. Bei normal besteht ein gedruckter Punkt aus 3 Pixeln horizontal und 3 Pixeln vertikal. Fine hingegen erzeugt aus einem zu druckenden Punkt einen Pixel horizontal und drei Pixel vertikal.
Druckbar im Grafikmodus sind maximal 8 Punkte in der Höhe, und 192 Punkte (normal) bzw. 576 Punkte (fine) in der Breite.
Nun besteht ein Bild ja im Normalfall aus mehr als nur 8 Punkten in der Höhe. Gelöst habe ich dies in Python. Die Grafik wird eingelesen, die Farbtiefe herunter gesetzt, so dass nur noch Schwarz-Weiß übrig ist, Grautöne gibt es keine.
Der nächste Schritt skaliert die Bilder, sollten sie zu breit sein, auf die passende Größe.
Im Anschluss wird das Bild abschnittsweise gelesen, immer acht Pixelzeilen auf einmal und auf dem Drucker ausgegeben. Einen ganzen Zeilenvorschub zwischen den Abschnitten kann ich nicht ausführen, sonst würde es Lücken zwischen den gedruckten Abschnitten geben und somit keine zusammenhängende Grafik zustande kommen.
In der Dokumentation finden sich aber auch Befehle, wie das Papier nur einen Bruchteil einer Zeile bewegt werden kann. Somit lassen sich auch größere Grafiken drucken.

Der Drucker unterstützt von Haus aus verschiedene eindimensionale Barcodes. Man sendet nur die Daten und der Barcode wird automatisch erzeugt. QR-Codes kann der Chaosprinter aber auch darstellen, dafür erzeuge ich über eine Python-Bibliothek dynamisch eine Grafik, die sofort im Anschluss gedruckt wird. Dies funktioniert zuverlässig.

Texte gibt man einfacher und schneller im Textmodus aus, allerdings muss man dort mit beschränkten Formatierungsmöglichkeiten auskommen.
Es stehen sechs Schriftgrößen zur Verfügung. Ein Text kann fett, unterstrichen oder invertiert, also schwarzer Hintergrund mit weißer Schrift, ausgegeben werden. Linksbündig, Rechtsbündig und Zentriert sind kein Problem, Blocksatz kann nicht genutzt werden. Man kann den Text auch auf den Kopf stellen sowie von oben nach unten ausgeben. Einen automatischen Zeilenumbruch gibt es nicht. Ist der zu druckende Text länger als die Zeile, wird der Text auf der nächsten Zeile fort gesetzt. Wörter werden hierbei noch am Ende der Zeile begonnen und dann am Anfang der nächsten Zeile vervollständigt.
Solltet ihr in unterschiedlichen Sprachen drucken wollen, auch dies ist kein Problem, der Drucker bringt einige Codepages mit, die aktiviert werden können. Natürlich müsst ihr euch selbst darum kümmern, dass das Encoding eures Textes beim Senden korrekt ist.

Damit man das Papier nicht abreißen muss, gibt es noch einen eingebauten Schneidemechanismus. Dieser schneidet auf Befehl das Papier komplett durch oder lässt in der Mitte einen Steg stehen.

Weitere Funktionen des Druckers, die ich bisher noch nicht genutzt habe, sind die Möglichkeit, ein Logo im Drucker zu hinterlegen und die Benutzung des „Cashdrawer“ Anschlusses.
Die Logofunktion erlaubt es einem eine kleine Grafik im internen Speicher des Druckers zu hinterlegen und später direkt von dort drucken zu lassen. Somit spart man sich die immer wiederkehrende Übertragung dieses Logos.
Der Cashdrawer-Anschluss dient dazu, eine Kassenschublade zu öffnen. Dabei wird ein kurzer Impuls auf Anschluss am Drucker, der als Westernbuchse ausgelegt wurde, gegeben. Diesen Anschluss werde ich bei Gelegenheit mit einem Relais versehen um darüber Lasten schalten zu können.

Im nächsten Teil verrate ich euch dann, wie ich die Anbindung an Twitter gelöst habe.

Advertisements




Wie ich programmieren lernte.

2 09 2012

In meinem Artikel über den Raspberry Pi habe ich ja schon angekündigt, dass das Prinzip, welches man verfolgt, genau richtig ist. Eine Maschine zu schwach für die neusten Spiele, stark genug um alle Möglichkeiten beim Experimentieren und Probieren zu haben.
Dieses Prinzip hat auch mich vor vielen Jahren an den Rechner gebracht. Während der Großteil schon einen 486er zu Hause stehen hatte, ein Teil schon zum Pentium wechselte, bekam ich meinen ersten eigenen Rechner. Einen 286er. Mit Turbotaste! Fun-Fact extra für @moellus: ein Highscreen!
Spielen konnte ich natürlich auch mit der Kiste. Allerdings eher einfache Sachen wie Lemmings, Accolade Grand Prix Circuit und das aufwendigste war F15 Strike Eagle II.
Doch es interessierte mich viel mehr. Die Kiste aufgeschraubt, geschaut, was funktioniert noch, wenn ich dieses und jenes abstecke oder ausbaue. Durch einfaches Probieren merkte ich, was essenziell ist und was unnütz. Nachdem ich die Hardware zumindest schon mal gesehen hatte und sie keine einfache Blechkiste mehr war, hab ich mich der Software gewidmet.
Basic fand ich persönlich doof, auch wenn ich bei einem Bekannten an seinem Sinclair Z80 viel Spaß damit hatte.
Irgendwie bin ich zu Turbo Pascal gekommen. Die 5er Version lief schnell und zuverlässig und ich konnte mit dem Programmieren beginnen. Damals gab es zwar schon das Internet, doch die Zugänge waren langsam und teuer. Glücklicherweise kam ich anders an alle möglichen Informationen. In Bekanntenkreis meiner Eltern wollte jemand seine gesammelten alten Computermagazine wegwerfen. Im Gegensatz zu heute enthielten die Hefte noch Unmengen an Listings, abgedrucktem Code verschiedenster Programme. Ich habe mich versucht in die Programme einzulesen, habe Teile abgetippt um zu sehen, was sie machen. Immer mehr hab ich verstanden und konnte somit auch eigene Programme schreiben. Nichts was die Welt bewegt aber kleine Programme die mich mit einem gewissen Stolz in meinem jungen Jahren erfüllt haben. Ich konnte etwas schreiben und der Computer tat danach genau das, was ich wollte – zumindest wenn ich nicht mal wieder irgendwo einen Fehler hatte. Ich möchte gar nicht wissen wie viele Tage und Nächte ich wirklich daran gesessen habe, bis ich programmieren konnte.
Die Art und Weise, wie ich Pascal gelernt habe, nutze ich heute noch um andere Sprachen zu lernen. Als ich mit Python anfing, habe ich Quelltexte aus dem Netz besorgt, kleine Tools und Skripte mussten herhalten, damit ich mich einarbeiten konnte. Es ging ohne größere Schwierigkeiten: Lesen, verstehen, ausprobieren, verbessern, Trial and Error quasi.
Hört auf dicke Bücher zu lesen und Unmengen an Zeit damit zu vergeuden.
Schnappt euch Codes und analysiert sie. Schreibt eigene Programme für eure Bedürfnisse.
Ihr könnt nichts kaputt machen. Im Zusammenspiel mit einem Versionsverwaltungssystem seid ihr auf der absolut sicheren Seite. Ein Hilfsmittel, welches mir zu Dos-Zeiten fehlte.

Also schreibt euch nicht ab, lernt programmieren!





Anleitung: Iron Blogger Skript (reloaded)

22 07 2012

Nach einigen Änderungen am Skript und dem Aufruf von Mako Hill, dass jemand mal das Iron Blogger Skript dokumentieren soll, wird es Zeit, endlich mal meine Anleitung auf den aktuellsten Stand zu bringen. Die alte Anleitung ist damit hinfällig. Wundert euch nicht, wenn euch einiges bekannt vorkommt – Dinge, die sich nicht geändert haben, habe ich aus der alten Anleitung übernommen.

The English version of this guide will be updated soon. Stay tuned.

In meiner Anleitung gehe ich wieder davon aus, dass ihr Debian nutzt. Solltet ihr ein anderes System verwenden, so müsst ihr die Befehle anpassen und evtl. heißen die Paketnamen dann ein wenig anders.

Was muss alles installiert sein?

  • git
  • python
  • python-yaml
  • python-dateutil
  • python-mako
  • python-lxml
  • python-feedparser
  • ledger
  • mutt

Wie installiere ich die Pakete?

Gebt auf der Konsole folgende Zeile ein – auch wenn hier ein Zeilenumbruch angezeigt werden sollte, es ist eine einzige Zeile!:

sudo apt-get install git python python-yaml python-dateutil python-mako python-lxml python-feedparser ledger mutt

Es werden die benötigten Pakete herunter geladen und installiert. Wenn eines der Pakete schon vorhanden ist, dann wird dieses automatisch übersprungen.

Woher bekomme ich das Iron Blogger Skript?

Wechselt auf der Konsole in das Verzeichnis, in dem ihr das Iron Blogger Skript später haben wollt, und führt folgende Zeile aus:

git clone https://github.com/chaosblog/iron-blogger.git

Es wird automatisch ein Verzeichnis „iron-blogger“ angelegt, dieses beinhaltet das Skript.

Was muss ich bei meinem Blog vorbereiten?

Erstellt eine neue Seite (kein Artikel) für die Teilnehmerliste. Verpasst der Seite eine Überschrift nach belieben.

Macht euch keine Mühe Text auf die Seite zu schreiben – jeglicher
Inhalt der Seite wird bei einer Generierung der Teilnehmerliste überschrieben.

Navigiert in eurem WordPress-Admininterface zu „Seiten“, in der Auflistung der vorhanden Seite taucht die gerade erzeugte Teilnehmerliste auf. Fahrt mit der Maus über den Link und merkt euch die ID-Nummer der Seite, diese wird später gebraucht.

Wenn der Link zur Seite beispielsweise https://chaosblog.wordpress.com/wp-admin/post.php?post=2&action=edit lautet, dann wäre die ID die ihr euch merken müsst die 2.

Was muss ich anpassen?

Die zentrale Konfigurationsdatei.
Nach meinen Änderungen gibt es nun eine zentrale Konfigurationsdatei – es ist nicht mehr nötig, wie bisher, verschiedenste Dateien zu bearbeiten. Eine Beispiel-Konfigurationsdatei wird schon mitgeliefert. Diese heißt „settings.cfg.dist“. Kopiert die Datei und gebt ihr den Namen „settings.cfg“. Die Datei hat folgenden Inhalt:

[general]
mail=addyourmail@here
start_date=YYYY/MM/DD
 
[blogsettings]
username=john_doe
xmlrpc_endpoint=http://blog-URL.tld/xmlrpc.php
blog_id=0
participants_page_id=12

[general]
Im Abschnitt general sind Mailadresse und Startdatum zu definieren.
Tragt bei „mail=“ die Mailadresse ein, die die Auswertungsmails am Ende einer Wertungswoche erhalten soll. Die Variable „start_date“ muss das Datum enthalten, an dem euer Iron Blogger Projekt gestartet ist. Das Datumsformat ist hierbei wie folgt festgelegt: YYYY/MM/DD. Das Jahr also vierstellig, der Monat zweistellig und der Tag ebenfalls zweistellig.

[blogsettings]
Der Abschnitt blogsettings enthält die notwendigen Informationen um mittels des Skriptes auf einen WordPress-Blog zugreifen zu können. Der „username“ muss den Nutzernamen eures WordPress-Zugangs enthalten. Die Variable „xmlrpc_endpoint“ muss die URL eures Blogs gefolgt von „/xmlrpc.php“ (ohne Anführungszeichen) enthalten.
Wenn eure Blog-URL z.B. https://chaosblog.wordpress.com heißt, dann wäre der einzutragende Wert https://chaosblog.wordpress.com/xmlrpc.php.
Sollte das Schema eurer XML-RPC-URL abweichen, dann schaut bitte direkt innerhalb der Administrationsoberfläche vorn WordPress nach, wie die URL lautet.
Die Variable „blog_id“ lasst ihr auf 0 stehen. Theoretisch könnte hier auch ein anderer Wert stehen – dieser Fall ist mir aber bisher noch nie in der Praxis begegnet. Solltet ihr hier etwas anderes eintragen müssen, dann wisst ihr es auch 😉
Als Letztes fehlt noch die participants_page_id. Dies ist die ID der Teilnehmerseite, die wir uns vorhin gemerkt haben.

Die Liste der Blogger
Die Datei bloggers.yml enthält die Blogger, die an eurer Iron Blogger Aktion teilnehmen.

username:
links:
- [Blogname 01,'http://blog-URL.tld/']
- [Blogname 02,'http://blog-URL02.tld/']
name: Jon Doe
start: YYYY/MM/DD

Der username entspricht dem Nick des Bloggers auf Twitter. Solltet ihr auch Blogger ohne Twitteraccount haben, so schreibt hier einen Nutzernamen hin, den ihr euch ausdenkt und fügt den optionalen Eintrag twitter:no zu dem Nutzer hinzu.

Im Abschnitt links tragt ihr den oder die Blogs ein, die ein einzelner Blogger betreibt. Hier werden nur ein Name und ein Link eingetragen – eine Feed-URL wird später automatisch ermittelt und eingetragen.
Das Feld name erhält den Klarnamen, bzw. dass was als Klarname angezeigt werden soll.
Damit auch nach dem Start der Aktion neue Teilnehmer hinzustoßen können, gibt es das Feld start. Dort wird eingetragen, ab wann ein Nutzer in die Wertung einfließt.
Achtung:Wenn ihr einen Wert in der Vergangenheit eintragt, heißt es nicht, dass für den User auch rückwirkend die Gebühren berechnet werden!
Zum besseren Verständnis hier ein Beispiel:
chaosblog:
links:
-[Chaosblog, 'https://chaosblog.wordpress.com/']
name: Marcus S.
start: 2012/01/01
twitter: no

Wie führe ich das Skript aus?

In Wirklichkeit ist es nicht ein einzelnes Skript, sondern mehrere Skripte, die zusammenarbeiten. Daher gibt es eine bestimmte Reihenfolge, die ihr einhalten müsst.

      1. Tragt alle Teilnehmer wie oben beschrieben in die Datei bloggers.yml ein.
      2. Führt das Skript import-feeds.py durch Eingabe von
        ./import-feeds.py
        aus. Die Datei bloggers.yml wird gelesen und zu allen Blog die noch keine Feed-URL eingetragen haben, wird die Feed-URL erzeugt.
      3. Nun könnt ihr die Teilnehmerliste auf eurem Blog aktualisieren lassen. Dies geschieht wieder auf der Konsole, diesmal ist der Befehl:
        ./update-participants.py
        Ihr werdet nun aufgefordert, euer Passwort einzugeben – dies ist das Passwort mit dem ihr euch auch im WordPress einloggt.
        Nach einigen Sekunden erscheint wieder der Eingabeprompt und die Teilnehmerliste eures Blogs wurde aktualisiert.
      4. Die Ermittlung der neuen Beiträge der einzelnen Teilnehmer übernimmt scan-feeds.py. Dieses Skript lädt nacheinander alle Feeds der Blogs und speichert die Titel und die Adressen der neuen Beiträge. Dies geschieht via:
        ./scan-feeds.py
      5. Nun könnt ihr einen Probelauf des Auswertungsskripts weekly-update.py starten. Der Parameter -n sorgt für einen Probelauf – es wird keine Mail verschickt und kein Blogartikel erzeugt. Allerdings wird der Text, der Mail, die generiert wird, auf der Konsole ausgegeben. Als zweiten Parameter beim Probelauf erwartet das Skript ein Datum im Format YYYY-MM-DD (z.B. 2012-01-19)
        ./weekly-update.py -n 2012-01-19
        Das Datum definiert die Woche für die die Auswertung erzeugt wird. Basierend auf dem Parameter und dem weiter oben konfigurierten Start-Datum wird die Woche berechnet. Für das Skript muss eine Woche nicht zwingend mit Sonntag oder Montag beginnen.
        Wenn ihr den Parameter -n durch -q ersetzt, bekommt ihr noch eine kompaktere Ansicht des Probelaufs.
      6. Jetzt wird es ernst. Wir lassen nun den Blogbeitrag mit der Auswertung und die E-Mail dazu erzeugen. Wieder wird das Skript weekly-update.py ausgeführt, diesmal wird allerdings nur ein Parameter, das Datum, übergeben.
        ./weekly-update.py 2012-01-15
        Wie bei der Aktualisierung der Teilnehmerliste werdet ihr auch hier nach eurem WordPress-Passwort gefragt.
        Nach einigen Sekunden ist der Blogpost erstellt und ihr solltet eine neue E-Mail in eurem Postfach vorfinden.

Fertig. War doch auch diesmal gar nicht schwer und sogar leichter als bei der ersten Version, oder? 😉

Noch ein Tipp: Legt euch bei WordPress.com einfach einen neuen bzw. einen weiteren Blog an, den ihr auf privat schaltet. Diesen könnt ihr dann als Spielwiese zum Testen nutzen.





Howto: Iron Blogger Script (English Version)

20 01 2012

Please excuse my really bad English. I did my best to write this post reasonably understandable.
Perhaps there is someone who helps me and corrects my mistakes.

This howto is available in German too.

As mentioned in my last post, there is the Iron Blogger script running on my server the with some adjustments.

Here is a brief guide on how to install and use this script. I created a new fork on Github and uploaded my changes uploaded there.

In my post I am assuming that you use Debian. Should you use a different system, please adjust the commands and then the package names.

What needs to be installed?

  • git
  • python
  • python-yaml
  • python-dateutil
  • python-mako
  • python-lxml
  • python-feedparser
  • mutt

How do I install the packages?

Run the following command (even if there appears a line break it’s only a single line):

sudo apt-get install git python python-yaml python-dateutil python-mako python-lxml python-feedparser mutt

Your system will load the required packages and install them. If one of the packages already exist, then it is skipped automatically.

How do I get the Iron Blogger script?

Changes into the directory where you want to have the Iron Blogger script later run the following line:

git clone https://github.com/chaosblog/iron-blogger.git

This command creates a directory „iron-blogger“ and downloads the script from Github.

What do I need to prepare?

Create a new page for the list of participants, the title you can choose at will.

Don’t write any text at this page – Any content of this will be overwritten by a generation of participant list.

Navigate in your WordPress admin interface to „Pages“. In the list of available pages appears the newly created one. Ride with the mouse over the link and you remember the ID number of the page, it will be used later.

If the link to the page, for example is https://chaosblog.wordpress.com/wp-admin/post.php?post=2&action=edit, then the ID which you have to remember is 2.

What do I need to adjust?

Currently there is no central configuration file.

  1. render.py
    Edit the File render.py. There you configure the start-date of your Iron Blogger Event.
    At Row 13:
    START = datetime.datetime(2011, 12, 25, 2)
    The dateformat is: yyyy, mm, dd, h
    The year (four digits), the month (two digits), the day (two digits), the hour (24 hour format).
  2. update-participants.py
    Edit file update-participants.py, adjust Rows 10-13 angepasst werden.
    XMLRPC_ENDPOINT = 'http://blog-URL.tld/xmlrpc.php'
    USER = 'username'
    BLOG_ID = 0
    PAGE_ID = 12
    The XMLRPC_ENDPOINT is your blog URL followed by „/xmlrpc.php“ (without quotation marks).
    When your blog URL  is https://chaosblog.wordpress.com so the needed value is https://chaosblog.wordpress.com/xmlrpc.php
    USER your username, used at the blog login page.
    Normally the BLOG_ID is 0 (zero) sein
    PAGE_ID is the remembered ID form your participants page.
  3. weekly-update.py
    Edit weekly-update.py similar to update-participants.py – Rows 11-13 need to be adjusted.
    XMLRPC_ENDPOINT = 'http://blog-URL.tld/xmlrpc.php'
    USER = 'username'
    BLOG_ID = 0
  4. bloggers.yml
    The file bloggers.yml contains the participants.
    username:
    links:
    - [Blogname 01,'http://blog-URL.tld/']
    - [Blogname 02,'http://blog-URL02.tld/']
    name: Jon Doe
    start: YYYY/MM/DD
    username corresponds with the bloggers twitter name. You could write any name – but if you don’t use twitter names, you have to edit the templates which generate the overview and the participants list. Both generate username based links for twitter.
    At the section links you have to enter the blog an user is running.
    Don’t add a feed-URL – they will generated later.
    The field name contains the bloggers realname.
    For blogger which will join the project later, there is the „start“ field.
    Caution:The fees are not calculated backdatedHere’s an example to illustrate:
    chaosblog:
    links:
    - [Chaosblog, 'https://chaosblog.wordpress.com/']
    name: Marcus S.
    start: 2012/01/01
  5. email.txt
    Only a short adjustment – replace at row 3 in the file email.txt the string „addyourmail@here“ with your e-Mail-adress.

How do I run the script?

It is not a single script, but several scripts that work together. Therefore, there is a specific order, you must follow.

  1. Add all participants to bloggers.yml.
  2. Run the script import-feeds.py via console:
    ./import-feeds.py

    The file bloggers.yml will be read and the missing feed-URLs will be added.
  3. Now you update the participants list by running:
    ./update-participants.py
    You will be aked to enter your WordPress password.
    After a few seconds the prompt will return and your participants list was updated.
  4. The determination of new contributions of each participant is done by scan-feeds.py. This script loads one after another feed and stores the titles and addresses of the new posts.
    Run this command:
    ./scan-feeds.py
  5. Go on with a dry run of the weekly results. weekly-update.py  with the parameter -n starts the dry run. No blog post will be done and no email will be send. The second parameter at the dry run is a date, formated YYYY-MM-DD (e.g. 2012-01-19)
    ./weekly-update.py -n 2012-01-19
    The date defines the week for the results. Based on the configured start and the parameter the week will be calculated. It is not necessary to start a week on sunday or monday.
  6. Now it gets seriously.
    Let’s generate a blog post and an email. Run the weekly-update.py script only with the date parameter:
    ./weekly-update.py -n 2012-01-15
    You will be asked once more to enter your WordPress-Password.
    After a few seconds your blog post is created and you will receive an e-mail

Finished. That is quite easy. Isn’t it? 😉

To-do:

  • one configuration file
  • store the wordpress password for automation

I’m going to implement both and when finished I will upload it to github again.

Tip: Created just a new WordPress.com blog and turn into private. This you can use as a playground to test everything.

Another tip: when you created just one new WordPress.com blog or another to whom you turn to private. These you can then use as a playground.





Anleitung: Iron Blogger Skript

20 01 2012

Wie bereits in meinem letzten Beitrag erwähnt, läuft auf meinem Server das Iron Blogger Skript mit einigen Anpassungen.

Hier eine kleine Anleitung, wie ihr das Skript bei euch installieren könnt.

Diese Anleitung gibt es auch in (miesem) Englisch.

Damit niemand meine Änderungen erneut machen muss, habe ich einen Fork auf Github erstellt und meine Änderungen dort wieder hochgeladen.

In meiner Anleitung gehe ich davon aus, dass ihr Debian nutzt. Solltet ihr ein anderes System verwenden, so müsst ihr die Befehle anpassen und evtl. heißen die Paketnamen dann ein wenig anders.

Was muss alles installiert sein?

  • git
  • python
  • python-yaml
  • python-dateutil
  • python-mako
  • python-lxml
  • python-feedparser
  • ledger
  • mutt

Wie installiere ich die Pakete?

Gebt auf der Konsole folgende Zeile ein – auch wenn hier ein Zeilenumbruch angezeigt wird, es ist eine einzige Zeile!:

sudo apt-get install git python python-yaml python-dateutil python-mako python-lxml python-feedparser ledger mutt

Es werden die benötigten Pakete herunter geladen und installiert. Wenn eines der Pakete schon vorhanden ist, dann wird dieses automatisch übersprungen.

Woher bekomme ich das Iron Blogger Skript?

Wechselt auf der Konsole in das Verzeichnis, in dem ihr das Iron Blogger Skript später haben wollt, und führt folgende Zeile aus:

git clone https://github.com/chaosblog/iron-blogger.git

Es wird automatisch ein Verzeichnis „iron-blogger“ angelegt, dieses beinhaltet das Skript.

Was muss ich bei meinem Blog vorbereiten?

Erstellt eine neue Seite (kein Artikel) für die Teilnehmerliste. Verpasst der Seite eine Überschrift nach belieben.

Macht euch keine Mühe Text auf die Seite zu schreiben – jeglicher Inhalt der Seite wird bei einer Generierung der Teilnehmerliste überschrieben.

Navigiert in eurem WordPress-Admininterface zu „Seiten“, in der Auflistung der vorhanden Seite taucht die gerade erzeugte Teilnehmerliste auf. Fahrt mit der Maus über den Link und merkt euch die ID-Nummer der Seite, diese wird später gebraucht.

Wenn der Link zur Seite beispielsweise https://chaosblog.wordpress.com/wp-admin/post.php?post=2&action=edit lautet, dann wäre die ID die ihr euch merken müsst die 2.

Was muss ich anpassen?

Aktuell gibt es noch keine zentrale Konfigurationsdatei, dies werde ich bei Gelegenheit noch ändern. Sobald das geschehen ist, werde ich die Änderungen wieder zu Github hochladen.

  1. render.py
    In der Datei render.py muss der Start eures Iron Blogger Events angepasst werden. Dies ist in Zeile 13 definiert:START = datetime.datetime(2011, 12, 25, 2)Das Datumsformat ist wie folgt: yyyy, mm, dd, h
    Das Jahr (vierstellig), der Monat (zweistellig), der Tag (zweistellig), die Stunde (im 24-Stundenformat).
  2. update-participants.py
    In der Datei update-participants.py müssen die Zeilen 10-13 angepasst werden.XMLRPC_ENDPOINT = 'http://blog-URL.tld/xmlrpc.php'
    USER = 'username'
    BLOG_ID = 0
    PAGE_ID = 12
    Der XMLRPC_ENDPOINT ist die URL eures Blogs gefolgt von „/xmlrpc.php“ (ohne Anführungszeichen).
    Wenn eure Blog-URL z.B. https://chaosblog.wordpress.com heißt, dann wäre der einzutragende Wert https://chaosblog.wordpress.com/xmlrpc.php
    USER ist euer Nutzername, den ihr beim Login eures Blogs nutzt.
    Die BLOG_ID dürfte in den meisten Fällen 0 sein, in Ausnahmefällen muss dies geändert werden.
    PAGE_ID ist die ID der Teilnehmerseite, die wir uns vorhin gemerkt haben.
  3. weekly-update.py
    In der Datei weekly-update.py müssen analog zur Datei update-participants.py die Zeilen 11-13 angepasst. werden.XMLRPC_ENDPOINT = 'http://blog-URL.tld/xmlrpc.php'
    USER = 'username'
    BLOG_ID = 0
    Diesmal muss allerdings keine PAGE_ID angegeben werden, da die wöchentlich geposteten Beiträge Artikel und keine Seiten sind.
  4. bloggers.yml
    Die Datei bloggers.yml enthält die Blogger die an eurer Iron Blogger Aktion teilnehmen.username:
    links:
    - [Blogname 01,'http://blog-URL.tld/']
    - [Blogname 02,'http://blog-URL02.tld/']
    name: Jon Doe
    start: YYYY/MM/DD
    Der username entspricht dem Nick des Bloggers auf Twitter. Solltet ihr auch Blogger ohne Twitteraccount haben, so schreibt hier einen Nutzernamen hin, den ihr euch ausdenkt – allerdings müsst ihr dann auch die Templates anpassen, die die Auswertung und die Teilnehmerliste generieren – hier wird basierend auf dem Usernamen ein Link zu Twitter generiert.
    Im Abschnitt links tragt ihr den oder die Blogs ein, die ein einzelner Blogger betreibt. Hier werden nur ein Name und ein Link eingetragen – eine Feed-URL wird später automatisch ermittelt und eingetragen.
    Das Feld name erhält den Klarnamen, bzw. dass was als Klarname angezeigt werden soll.
    Damit auch nach dem Start der Aktion neue Teilnehmer hinzustoßen können, gibt es das Feld start. Dort wird eingetragen, ab wann ein Nutzer in die Wertung einfließt.
    Achtung:Wenn ihr einen Wert in der Vergangenheit eintragt, heißt es nicht, dass für den User auch rückwirkend die Gebühren berechnet werden!Zum besseren Verständnis hier ein Beispiel:chaosblog:
    links:
    - [Chaosblog, 'https://chaosblog.wordpress.com/']
    name: Marcus S.
    start: 2012/01/01
  5. email.txt
    Nun eine kleine Änderung. In der Datei email.txt müsst ihr in Zeile 3 die Zeichenkette „addyourmail@here“ durch eure E-Mail-Adresse ersetzen.

Wie führe ich das Skript aus?

In Wirklichkeit ist es nicht ein einzelnes Skript, sondern mehrere Skripte, die zusammenarbeiten. Daher gibt es eine bestimmte Reihenfolge, die ihr einhalten müsst.

  1. Tragt alle Teilnehmer wie oben beschrieben in die Datei bloggers.yml ein.
  2. Führt das Skript import-feeds.py durch Eingabe von
    ./import-feeds.py
    aus. Die Datei bloggers.yml wird gelesen und zu allen Blog die noch keine Feed-URL eingetragen haben, wird die Feed-URL erzeugt.
  3. Nun könnt ihr die Teilnehmerliste auf eurem Blog aktualisieren lassen. Dies geschieht wieder auf der Konsole, diesmal ist der Befehl:
    ./update-participants.py
    Ihr werdet nun aufgefordert, euer Passwort einzugeben – dies ist das Passwort mit dem ihr euch auch im WordPress einloggt.
    Nach einigen Sekunden erscheint wieder der Eingabeprompt und die Teilnehmerliste eures Blogs wurde aktualisiert.
  4. Die Ermittlung der neuen Beiträge der einzelnen Teilnehmer übernimmt scan-feeds.py. Dieses Skript lädt nacheinander alle Feeds der Blogs und speichert die Titel und die Adressen der neuen Beiträge. Dies geschieht via:
    ./scan-feeds.py
  5. Nun könnt ihr einen Probelauf des Auswertungsskripts weekly-update.py starten. Der Parameter -n sorgt für einen Probelauf – es wird keine Mail verschickt und kein Blogartikel erzeugt. Allerdings wird der Text, der Mail, die generiert wird, auf der Konsole ausgegeben. Als zweiten Parameter beim Probelauf erwartet das Skript ein Datum im Format YYYY-MM-DD (z.B. 2012-01-19)
    ./weekly-update.py -n 2012-01-19
    Das Datum definiert die Woche für die die Auswertung erzeugt wird. Basierend auf dem Parameter und dem weiter oben konfigurierten Start-Datum wird die Woche berechnet. Für das Skript muss eine Woche nicht zwingend mit Sonntag oder Montag beginnen.
  6. Jetzt wird es ernst. Wir lassen nun den Blogbeitrag mit der Auswertung und die E-Mail dazu erzeugen. Wieder wird das Skript weekly-update.py ausgeführt, diesmal wird allerdings nur ein Parameter, das Datum, übergeben.
    ./weekly-update.py -n 2012-01-15
    Wie bei der Aktualisierung der Teilnehmerliste werdet ihr auch hier nach eurem WordPress-Passwort gefragt.
    Nach einigen Sekunden ist der Blogpost erstellt und ihr solltet eine neue E-Mail in eurem Postfach vorfinden.

Fertig. War doch gar nicht schwer, oder? 😉

Was jetzt noch fehlt, ist eine zentrale Konfigurationsdatei, in der man alle nötigen Änderungen zentral vornehmen kann.
Des Weiteren sollte es noch möglich sein, das WordPress-Passwort zu hinterlegen, damit das Skript auch voll automatisiert ausgeführt werden kann.
Eine Verbesserung wäre auch das Auswertungsskript quasi „lautlos“ laufen zu lassen – es wird keine Mail verschickt und kein Blogpost erstellt – aber die Finanzen werden aktualisiert. Damit könnte man das Skript auch ohne Weiteres bei bestehenden Iron Blogger Projekten einsetzen.

Beides werde ich im Laufe der Zeit noch implementieren und auf Github hochladen.

Noch ein Tipp: Legt euch bei WordPress.com einfach einen neuen bzw. einen weiteren Blog an, den ihr auf privat schaltet. Diesen könnt ihr dann als Spielwiese nutzen.





Iron Blogger. Jetzt erst recht.

19 01 2012

So, ich bin nun also doch Iron Blogger geworden – denn was interessiert mich mein Geschwätz von gestern? 🙂

Der Herr @moellus ist schuld, mit seinem neuen voll knorken Projekt Cynigma.

Zur Auswertung, wer nun in der Bierschuld ist und wer nicht, gibt es ein Skript. Nachdem ich mitbekommen habe, dass das Skript bei Iron Blogger Berlin noch nicht läuft, habe ich es bei mir auf meinem Server aufgesetzt. Dachte ich anfangs noch ein einfaches „git clone“ und anpassen der Blogliste würde reichen, wurde ich eines Besseren belehrt. Python schmiss sofort eine Fehlermeldung. Dummerweise gibt es keine Doku, wie man das Skript nutzt.

Also hab ich meine Entwicklerbrille aufgesetzt und mich in den Code eingelesen. Ahh! Es fehlen noch ein paar Module auf meiner Kiste.
Daher erst mal geschwind die Module installiert.
Die Finanzen verwaltet das Skript via ledger in einer einzelnen Datei – also musste dies auch noch den Weg auf meinen Server finden.

Trotzdem machte das Pythonskript noch nicht, was es sollte. Beispielsweise stieg das Skript aus, als ich das erste Mal die Feeds abrufen wollte oder aber auch, wenn noch keiner seine Bierschulden bezahlt hat. Es fehlte hier und da an einem sinnvollen Fehlerhandling. Die Macken habe ich beseitigt, die Templates für die Wochenauswertung und die Teilnehmerliste angepasst, die Währung von Dollar auf Euro geändert und ein wenig Kosmetik walten lassen.

Die einzelnen Teilnehmer sind mit ihren Blogs in einer zentralen Datei erfasst. Diese habe ich auch erweitert, damit nicht nur ein Username eingetragen ist, sondern auch die Möglichkeit besteht, einen Klarnamen einzutragen. Sieht einfach besser in der Auswertung aus.

Ich wünsche allen Iron Blogger Berlin Teilnehmern viel Spaß und Erfolg.
Sollte jemand Fehler entdecken, die das Skript produziert, Änderungswünsche oder Verbesserungsvorschläge haben, meldet euch einfach mal bei mir über die bekannten Wege. Natürlich dürft ihr auch gern einen Kommentar hinterlassen, wenn es euch gefällt, dass das Skript läuft.

Eine Anleitung, wie ihr das Skript selbst zum Laufen bekommt, folgt gibt es hier.