confluenceDumpWithPython

Confluence Dump mit Python

Erstellen Sie Confluence-Seiten mit Python (Anfragen) im HTML- und RST-Format, einschließlich eingebetteter Bilder und Anhänge. Verweise auf heruntergeladene Dateien werden auf ihren lokalen relativen Pfad aktualisiert.

Beschreibung

Dennoch erfordert das Refactoring nur zwei Dateien und akzeptiert Befehlszeilenargumente:

• myModules.py : Enthält alle erforderlichen Funktionen.
• confluenceDumpWithPython.py : Skript zur Verwendung mit den folgenden Befehlszeilenargumenten:
  • -m, --mode : Der Exportmodus, single , space , bylabel , pageprops (erforderlich).
    • Hinweis: Bisher wurden nur single , pageprops und space implementiert.
  • -S, --site : Die Atlassian-Site (erforderlich).
  • -s, --space : Die Leertaste (falls erforderlich).
  • -p, --page : Die Seiten-ID (falls erforderlich).
  • -l, --label : Das Seitenlabel (falls erforderlich).
  • -x, --sphinx : Die Ordner _images und _static werden im Stammverzeichnis des Exportordners abgelegt und nicht zusammen mit den exportierten HTML-Dateien.
  • --notags : Fügt die Tags-Anweisungen nicht zu den ersten Dateien hinzu (wenn das sphinx-tags Add-on nicht verwendet wird).
• updatePageLinks.py : Online-Confluence-Links auf die lokalen Dateien aktualisieren, die bisher heruntergeladen wurden.
  • --folder : Ordner mit den zu aktualisierenden Dateien.
  • --test : Anstatt die ursprünglichen .rst-Dateien zu überschreiben, werden aktualisierte Dateien mit zout_ als Präfix erstellt.
• getPageEditorVersion.py : Holen Sie sich die Editorversion von einzelnen Seiten oder allen Seiten in einem Bereich.
  • --site : Die Atlassian-Site (erforderlich).
  • --page : Seiten-ID (entweder/oder)
  • --space : Leertaste (entweder/oder)

Für das CSS-Styling wird die confluence.css von Confluence verwendet, die mithilfe des in: https://jira.atlassian.com/browse/CONFSERVER-40907 beschriebenen Workarounds abgerufen werden kann. Die in Confluence UI-HTML-Exporten enthaltene Datei site.css ist nicht so vollständig wie die obige.

Ordner- und Dateistruktur:

• Der Standardausgabeordner ist output/ unter demselben Pfad wie das Skript.
• Unter dem Ausgabeordner wird ein Ordner mit dem Space-Namen, der Berichtsseite „Seiteneigenschaften“, dem Namen einer einzelnen Seite oder dem Namen der Seitenbeschriftung erstellt.
• Standardmäßig werden die Ordner _images/ und _static/ im Ordner page|space|pageprops|label abgelegt.
  • Mit der Befehlszeilenoption --sphinx werden diese Ordner direkt unter dem Ausgabeordner abgelegt
• Die Datei styles/confluence.css wird in das definierte _static/ kopiert.

Was es bewirkt

• Nutzt die Confluence Cloud API
• Fügt Confluence-Metadaten wie Seiten-ID und Seitenbeschriftungen in die HTML-Header und RST-Felder ein.
• beautifulsoup wird zum Parsen von HTML verwendet, um Inhalte abzurufen und zu aktualisieren, d. h. Ändern Sie Remote-Links in lokale Links.
• Laden Sie jede Seite, alle Anhänge, Emoticons und eingebetteten Dateien herunter.

Anforderungen

• Systemvariablen deklarieren:
  • atlassianAPIToken
  • atlassianUserEmail

Abhängigkeiten

• Python3
  • Anfragen
  • schöne Suppe4
  • Kissen (Bilder anfassen)
  • pandoc & pypandoc (in RST konvertieren)
  • Re

Installieren

• Klon-Repo.
• Abhängigkeiten installieren.
• Deklarieren Sie Systemvariablen für Atlassian API Token.

Ausführendes Programm

• So laden Sie eine einzelne Seite anhand ihrer ID herunter.

 confluenceDumpWithPython.py -m single -S  -p  [
] [--sphinx]

• So laden Sie Seiteneigenschaften und alle darin enthaltenen Seiten herunter.

 confluenceDumpWithPython.py -m pageprops -S  -p  [
] [--sphinx]

• So laden Sie einen ganzen Space herunter.

 confluenceDumpWithPython.py -m space -S  -s  [
]

Helfen

Keine besonderen Ratschläge außer:

• Stellen Sie sicher, dass Ihr Atlassian API Token gültig ist.
• Der Benutzername für die Cloud Atlassian API ist die E-Mail-Adresse.

Autoren

Namen und Kontaktinformationen der Mitwirkenden

@dernorberto

Verbesserungen

• Export basierend auf Seitenbezeichnung hinzufügen.
• Fügen Sie Links zu Downloads für die entsprechenden Seiten hinzu.
• Aktualisieren Sie alle Links von heruntergeladenen Seiten zu den lokalen Kopien.
• Fügen Sie den Kopfzeilen die übergeordnete Seite und Seitenbeschriftungen hinzu.
• Erstellen Sie einen Index der Seiten, die als Inhaltsverzeichnis verwendet werden sollen.
• Erstellen Sie ein Seitenlayout, um Inhaltsverzeichnis und Artikel anzuzeigen.
• Kopieren Sie styles/site.css in output/styles/ falls nicht vorhanden.
• Erlauben Sie die Verwendung mit Confluence Server.

Probleme

• Es mag keine sehr langen Anhangsdateien, Sie müssen sie vor dem Dump in Confluence umbenennen.
• Seiten, die zuvor von Confluence Server migriert wurden, könnten Probleme mit alten Emoticons haben. Am besten konvertieren Sie die Seiten in den neuen Editor, der die fehlenden Emoticons ersetzt.

Versionsverlauf

• 1.4
  • Umgestaltung in ein einfacheres Datei-Setup ( confluenceDumpWithPython.py & myModules.py )
• 1.3
  • Space-Export hinzugefügt (flache Ordnerstruktur)
• 1.2
  • Bessere HTML-Kopf- und Fußzeile hinzugefügt.
  • Seitenbeschriftungen zu HTML-Headern hinzugefügt.
  • Verbesserte Argumentlogik für den Ausgabeordner.
• 1.1
  • Papge Properties-Dump und andere kleinere Dinge hinzugefügt
• 1,0
  • Erstveröffentlichung

Legacy/-Ordner mit früheren Skriptversionen

Zweck der Dateien:

1. confluenceExportHTMLrequestsByLabel.py : Laden Sie eine Reihe von Seiten herunter, die auf einem (oder mehreren) Seitenlabels basieren.
2. confluenceExportHTMLrequestsSingle.py : Laden Sie eine einzelne Seite herunter, indem Sie die Seiten-ID als Argument angeben.
3. confluenceExportHTMLrequestsPagePropertiesReport.py : Laden Sie Seiteneigenschaften und alle Seiten im Bericht herunter, indem Sie die Seiten-ID als Argument angeben.
4. confluenceExportHTMLrequestsPagesInSpace.py : Alle Seiten aus einem Space herunterladen.

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert – Einzelheiten finden Sie in der Datei LICENSE.txt

Danksagungen