shot-scraper

shot-scraper ist ein Werkzeug, mit dem sich der Prozess der Aktualisierung von Screenshots automatisieren lässt.

Installation

$ pipenv install shot-scraper
$ shot-scraper install

Bemerkung

Die zweite Zeile installiert den benötigten Browser.

Verwendung

shot-scraper kann auf zweierleis Art verwendet werden

  1. …für einzelne Screenshots auf der Kommandozeile:

    $  shot-scraper https://jupyter-tutorial.readthedocs.io/de/latest/clean-prep/index.html -o ~/Downloads/clean-prep.png
    

    …oder mit zusätzlichen Optionen, z.B. für JavaScript- und CSS-Selektoren:

    $ pipenv run shot-scraper https://jupyter-tutorial.readthedocs.io/de/latest/clean-prep/index.html -s '#overview' -o ~/Downloads/clean-prep.png
    
  2. …für eine Reihe von Screenshots, die in einer YAML-Datei konfiguriert sind:

    - url: https://jupyter-tutorial.readthedocs.io/de/latest/clean-prep/index.html
      output: ~/Downloads/clean-prep.png
    - url: https://www.example.org/
      width: 736
      quality: 40
      output: example.jpg
    

    Anschließend kann shot-scraper multi verwendet werden, z.B.:

    $ pipenv run shot-scraper multi shots.yaml
    Screenshot of 'https://jupyter-tutorial.readthedocs.io/de/latest/clean-prep/index.html' written to '~(Downloads/clean-prep.png'
    Screenshot of 'https://www.example.org/' written to 'example.jpg'
    

    Siehe auch

    • In der README.md-Datei findet ihr eine vollständige Übersicht über die möglichen Optionen.

    • Im shot-scraper-demo-Repository findet ihr eine deutlich umfangreichere shots.yaml-Datei.

GitHub-Actions

shot-scraper lässt sich einfach in GitHub Actions einbinden. Im shot-scraper-demo-Repository findet sich auch eine examplarische shots.yml. Einmal am Tag werden zwei Screenshots erzeugt und zurück in das Repository übertragen. Beachtet jedoch, dass das Speichern von Bilddateien, die sich häufig ändern, die Revisionshistorie sehr unleserlich machen können. Daher solltet ihr shot-scraper mit Bedacht zusammen mit GitHub Actions verwenden.