dssCode (Plattform zur Kodierung)

Zugang über `dsstools`

Wenn du einen Graph importieren möchtest, der zuvor in dssCode kodiert wurde, gehe dazu in dssCode in deine Profileinstellungen und kopiere das dortige API-Token. Das ist der Schlüssel für den Zugriff auf die Plattform aus Python heraus.

Warnung

Committe dieses Token niemals in Repositories!

Deshalb wollen wir unbedingt vermeiden, das Token in unser Skript zu schreiben, auch wenn wir es einfach als Parameter übergeben. Stattdessen müssen wir es anderweitig übergeben. Das lässt sich am besten über eine sogenannte Umgebungsvariable erledigen. Eine Umgebungsvariable besteht aus einem Schlüssel und einem Wert, ähnlich wie ein Item in einem Dictionary in Python.

Der Plan ist also wie folgt: 1. Wir legen die Umgebungsvariable auf eine Art und Weise fest, die nicht veröffentlicht wird. 2. Wir lesen diese Umgebungsvariablen wieder im laufenden Pythoncode in eine Python-Variable ein. 3. Diese Python-Variable wird an die Methode übergeben, die das Token benötigt.

Für 1. gibt es zwei Möglichkeiten:

Projekt-Slug

Weiterhin benötigst du von dssCode das sogenannte Projekt-Slug. Das ist ein menschenleserlicher String, der keine Leerzeichen oder Sonderzeichen enthält. Wenn du dich in der Projektübersicht befindest, steht der Slug in deiner Adresszeile des Browsers:

In diesem Beispiel wäre das sustainable_investment.

Snapshot

Snapshots dienen dazu, einen festgelegten Zustand aus dssCode zu erhalten. Die Erstellung eines solches Snapshots funktioniert in dssCode über Projektübersicht -> Snapshots -> Snapshot anlegen. Danach erscheint ein neuer Eintrag in der Tabelle darunter. Diese ID muss kopiert werden und ist unser Wert für snapshot in Python.

Hinweis

Diese Snapshot-ID kann committet werden. Das ist sogar sinnig, da andere Personen in deinem Team dann denselben Zustand in ihrem Netzwerk erhalten.

Anwendung

Ein simpler Aufruf sähe dann so aus:

G = dts.import_from_data_forge(
    "sustainable_investment",
    "hhhhhhhhhhhhhhhhhh" # (1)
)

Platzhalter für die Snapshot-ID

Das kann je nach Größe des Graphs etwas dauern. Standardmäßig wird dieser Aufruf gecached, was bedeutet, das nicht bei jedem Aufruf erneut die API aufgerufen wird. Das reduziert die Last auf dem Server. Dazu musst du aber nichts weiter tun.