green-spider/README.md

61 lines
2.7 KiB
Markdown
Raw Normal View History

2018-04-17 16:33:27 +02:00
# Green Spider
2018-04-03 23:15:28 +02:00
2018-08-23 10:00:55 +02:00
Initiative und Tools zur Förderung eines benutzer*innenfreundlichen Auftritts von Bündnis 90/Die Grünen im Web.
Zur Auswertung: [https://green-spider.netzbegruenung.de/](https://green-spider.netzbegruenung.de/)
2018-04-03 23:15:28 +02:00
2018-04-17 16:33:27 +02:00
## Tools
2018-04-03 23:15:28 +02:00
2019-05-04 23:01:04 +02:00
- **Spider:** Sammelt Informationen über Websites von B90/GRÜNE Gliederungen
- **Screenshotter:** Erstellt Seiten-Screenshots. Siehe [netzbegruenung/green-spider-screenshotter](https://github.com/netzbegruenung/green-spider-screenshotter/)
- **Webapp:** Darstellung der Spider-Ergebnisse. Siehe [netzbegruenung/green-spider-webapp](https://github.com/netzbegruenung/green-spider-webapp/). Dazu gehören
- **API**: [netzbegruenung/green-spider-api](https://github.com/netzbegruenung/green-spider-api)
- **Elasticsearch**
- **Indexer:** Lädt Ergebnisdaten in Elasticsearch. Siehe [netzbegruenung/green-spider-indexer](https://github.com/netzbegruenung/green-spider-indexer)
- **Auswertung**: R Projekt zur Auswertung der Ergebnisse. Siehe [netzbegruenung/green-spider-analysis](https://github.com/netzbegruenung/green-spider-analysis)
2018-04-17 16:33:27 +02:00
## Aktivitäten
Es ist geplant, auf Basis der gesammelten Informationen (siehe Spider) Informationen an die Betreiber*innen der Websites zu versenden. Hierzu müssen Prozesse erarbeitet und vermutlich weitere Tools geschaffen werden.
## Community
2018-04-17 16:57:02 +02:00
Green Spider ist ein Projekt des [netzbegrünung](https://blog.netzbegruenung.de/) e. V. -- Mitwirkung ist herzlich willkommen.
2018-04-17 16:33:27 +02:00
2018-04-17 16:57:02 +02:00
Zur Kommunikation dient der Chatbegrünung-Kanal [#green-spider](https://chatbegruenung.de/channel/green-spider) sowie die [Issues](https://github.com/netzbegruenung/green-spider/issues) hier in diesem Repository.
2018-04-17 16:33:27 +02:00
2019-05-04 23:01:04 +02:00
## Betrieb
2018-04-17 16:33:27 +02:00
2019-05-04 23:01:04 +02:00
Alle Informationen zum Betrieb befinden sich im Verzeichnis [devops](https://github.com/netzbegruenung/green-spider/tree/master/devops).
2018-04-17 16:33:27 +02:00
2019-05-04 23:01:04 +02:00
## Entwicklung
2018-08-28 22:28:40 +02:00
2019-05-04 23:01:04 +02:00
Green Spider ist in Python 3 geschrieben und wird aktuell unter 3.6 getestet und ausgeführt.
2018-04-17 16:33:27 +02:00
2019-05-04 23:01:04 +02:00
Aufgrund zahlreicher Dependencies empfiehlt es sich, den Spider Code lokal in Docker
auszuführen.
2018-04-17 16:33:27 +02:00
2019-05-04 23:01:04 +02:00
Das Image wird über den folgenden Befehl erzeugt:
2018-04-05 19:39:09 +02:00
```nohighlight
2019-05-04 23:01:04 +02:00
make
2018-04-05 19:39:09 +02:00
```
2019-05-04 23:01:04 +02:00
Das dauert beim ersten Ausführen einige Zeit, wiel einige Python-Module das Kompilieren diverser Libraries erfordern.
Nach dem ersten erfolgreichen Durchlauf dauert ein neuer Aufruf von `make` nur noch wenige Sekunden.
2018-08-23 10:00:55 +02:00
2019-05-04 23:01:04 +02:00
### Tests ausführen
2018-08-23 10:00:55 +02:00
2019-05-04 23:01:04 +02:00
In aller Kürze: `make test`
2018-04-17 16:33:27 +02:00
2019-05-04 23:01:04 +02:00
### Spider ausführen
2018-04-17 20:45:51 +02:00
2019-05-04 23:01:04 +02:00
Der Spider kann einzelne URLs verarbeiten, ohne die Ergebnisse in eine Datenbank zu schreiben.
Am einfachsten geht das über den `make spider` Befehl, so:
2018-04-17 20:45:51 +02:00
2019-05-04 23:01:04 +02:00
```nohighlight
make spider ARGS="--url http://www.example.com/"
```
2018-04-17 16:33:27 +02:00
2019-05-04 23:01:04 +02:00
Ohne `ARGS` aufgerufen, arbeitet der Spider eine Jobliste ab. Dies erfordert Zugriff auf die entsprechende Datenank.