confluenceDumpWithPython

Confluence Dump avec Python

Videz les pages Confluence à l'aide de Python (requêtes) au format HTML et RST, y compris les images et pièces jointes intégrées. Les références aux fichiers téléchargés seront mises à jour avec leur chemin relatif local.

Description

Néanmoins, la refactorisation ne nécessitera que 2 fichiers et acceptera les arguments de ligne de commande :

• myModules.py : Contient toutes les fonctions requises.
• confluenceDumpWithPython.py : Script à utiliser avec les arguments de ligne de commande suivants :
  • -m, --mode : Le mode d'exportation, single , space , bylabel , pageprops (obligatoire).
    • Remarque : Seuls single , pageprops et space ont été implémentés jusqu'à présent.
  • -S, --site : Le site Atlassian (obligatoire).
  • -s, --space : La clé espace (si nécessaire).
  • -p, --page : L'ID de la page (si nécessaire).
  • -l, --label : L'étiquette de la page (si nécessaire).
  • -x, --sphinx : Les dossiers _images et _static sont placés à la racine du dossier d'exportation, au lieu d'être placés avec les fichiers HTML exportés.
  • --notags : N'ajoute pas les directives tags aux premiers fichiers (lorsque l'addon sphinx-tags n'est pas utilisé).
• updatePageLinks.py : Mettez à jour les liens de confluence en ligne vers les fichiers locaux qui ont été téléchargés jusqu'à présent.
  • --folder : Dossier contenant les fichiers à mettre à jour.
  • --test : Au lieu d'écraser les fichiers .rst d'origine, il en créera des mis à jour avec zout_ comme préfixe.
• getPageEditorVersion.py : Obtenez la version de l'éditeur à partir de pages uniques ou de toutes les pages d'un espace.
  • --site : Le site Atlassian (obligatoire).
  • --page : ID de la page (soit/ou)
  • --space : Touche Espace (soit/ou)

Pour le style CSS, il utilise le confluence.css de Confluence qui peut être obtenu en utilisant la solution de contournement décrite dans : https://jira.atlassian.com/browse/CONFSERVER-40907. Le fichier site.css inclus avec les exports HTML de Confluence UI n'est pas aussi complet que celui ci-dessus.

Structure des dossiers et des fichiers :

• Le dossier de sortie par défaut est output/ sous le même chemin que le script.
• Un dossier avec le nom de l'espace, la page du rapport Propriétés de la page, le nom d'une seule page ou le nom de l'étiquette de page sera créé sous le dossier de sortie.
• Par défaut, les dossiers _images/ et _static/ seront placés dans le dossier page|space|pageprops|label.
  • L'option de ligne de commande --sphinx placera ces dossiers directement sous le dossier de sortie
• Le fichier styles/confluence.css sera copié dans le _static/ défini

Ce que ça fait

• Tire parti de l'API Confluence Cloud
• Place les métadonnées Confluence telles que l'ID de page et les étiquettes de page, dans les en-têtes HTML et les champs RST.
• beautifulsoup est utilisé pour analyser le HTML pour obtenir et mettre à jour le contenu, c'est-à-dire. remplacez les liens distants par des liens locaux.
• Téléchargez pour chaque page, toutes les pièces jointes, émoticônes et fichiers intégrés.

Exigences

• déclarer les variables système :
  • atlassianAPIToken
  • atlassianUserEmail

Dépendances

• python3
  • demandes
  • bellesoup4
  • Oreiller (images de poignée)
  • pandoc & pypandoc (convertir en RST)
  • concernant

Installation

• Cloner le dépôt.
• Installez les dépendances.
• Déclarez les variables système pour le jeton API Atlassian.

Exécution du programme

• Comment télécharger une seule page en fonction de son identifiant.

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

• Comment télécharger les propriétés de la page et toutes les pages contenues.

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

• Comment télécharger un espace entier.

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

Aide

Pas de conseils particuliers hormis :

• assurez-vous que votre jeton API Atlassian est valide.
• le nom d'utilisateur de l'API Cloud Atlassian est l'adresse e-mail.

Auteurs

Noms et coordonnées des contributeurs

@dernorberto

Améliorations

• Ajoutez une exportation basée sur l'étiquette de la page.
• Ajoutez des liens vers les téléchargements pour les pages correspondantes.
• Mettez à jour tous les liens des pages téléchargées vers les copies locales.
• Ajoutez aux en-têtes la page parent et les étiquettes de page.
• Créez un index des pages à utiliser comme table des matières.
• Créez une mise en page pour afficher les articles TOC +.
• Copiez styles/site.css dans output/styles/ s'il n'est pas présent.
• Autoriser l'utilisation avec Confluence Server.

Problèmes

• Il n'aime pas les pièces jointes très longues, vous devrez les renommer dans Confluence avant le dump.
• Les pages précédemment migrées depuis Confluence Server peuvent rencontrer des problèmes avec les anciennes émoticônes. Le mieux est de convertir les pages vers le Nouvel Éditeur, qui remplacera les émoticônes manquantes.

Historique des versions

• 1.4
  • Refactorisation vers une configuration de fichier plus simple ( confluenceDumpWithPython.py & myModules.py )
• 1.3
  • Exportation spatiale ajoutée (structure de dossiers plate)
• 1.2
  • Ajout d'un meilleur en-tête et pied de page HTML.
  • Ajout d'étiquettes de page aux en-têtes HTML.
  • Logique d'argument du dossier de sortie améliorée.
• 1.1
  • Ajout du dump Papge Properties et d'autres petites choses
• 1.0
  • Version initiale

héritage/dossier avec la version précédente des scripts

Objectif des fichiers :

1. confluenceExportHTMLrequestsByLabel.py : télécharge un ensemble de pages basé sur une (ou plusieurs) étiquettes de page.
2. confluenceExportHTMLrequestsSingle.py : téléchargez une seule page en fournissant l'ID de la page en argument.
3. confluenceExportHTMLrequestsPagePropertiesReport.py : télécharge les propriétés de la page et toutes les pages du rapport en fournissant l'ID de la page en argument.
4. confluenceExportHTMLrequestsPagesInSpace.py : télécharge toutes les pages d'un espace.

Licence

Ce projet est sous licence MIT - voir le fichier LICENSE.txt pour plus de détails

Remerciements