confluenceDumpWithPython

Volcado de confluencia con Python

Volcar páginas de Confluence usando Python (solicitudes) en formato HTML y RST, incluidas imágenes y archivos adjuntos incrustados. Las referencias a los archivos descargados se actualizarán a su ruta relativa local.

Descripción

No obstante, la refactorización requerirá solo 2 archivos y aceptará argumentos de línea de comando:

• myModules.py : contiene todas las funciones requeridas.
• confluenceDumpWithPython.py : Script para usar con los siguientes argumentos de línea de comando:
  • -m, --mode : el modo de exportación, single , space , bylabel , pageprops (obligatorio).
    • Nota: Hasta ahora solo se han implementado single , pageprops y space .
  • -S, --site : El sitio de Atlassian (obligatorio).
  • -s, --space : la tecla Espacio (si es necesario).
  • -p, --page : el ID de la página (si es necesario).
  • -l, --label : la etiqueta de la página (si es necesario).
  • -x, --sphinx : las carpetas _images y _static se colocan en la raíz de la carpeta de exportación, en lugar de junto con los archivos HTML exportados.
  • --notags : No agrega las directivas de etiquetas a los primeros archivos (cuando no se usa el complemento sphinx-tags ).
• updatePageLinks.py : actualiza los enlaces de confluencia en línea a los archivos locales que se han descargado hasta el momento.
  • --folder : Carpeta que contiene los archivos a actualizar.
  • --test : en lugar de sobrescribir los archivos .rst originales, creará archivos actualizados con zout_ como prefijo.
• getPageEditorVersion.py : obtiene la versión del editor de páginas individuales o de todas las páginas en un espacio.
  • --site : El sitio de Atlassian (obligatorio).
  • --page : ID de página (cualquiera/o)
  • --space : Tecla de espacio (cualquiera/o)

Para el estilo CSS, utiliza confluence.css de Confluence que se puede obtener utilizando la solución alternativa descrita en: https://jira.atlassian.com/browse/CONFSERVER-40907. El archivo site.css incluido con las exportaciones HTML de la interfaz de usuario de Confluence no es tan completo como el anterior.

Estructura de carpetas y archivos:

• La carpeta de salida predeterminada es output/ en la misma ruta que el script.
• Se creará una carpeta con el nombre del espacio, la página del informe Propiedades de la página, el nombre de una sola página o el nombre de la etiqueta de la página en la carpeta de salida.
• De forma predeterminada, las carpetas _images/ y _static/ se colocarán en la carpeta page|space|pageprops|label.
  • La opción de línea de comando --sphinx colocará esas carpetas directamente debajo de la carpeta de salida
• El archivo styles/confluence.css se copiará en el archivo _static/ definido.

que hace

• Aprovecha la API de Confluence Cloud
• Coloca metadatos de Confluence, como ID de página y etiquetas de página, en los encabezados HTML y los campos RST.
• beautifulsoup se utiliza para analizar HTML para obtener y actualizar contenido, es decir. cambiar enlaces remotos a enlaces locales.
• Descargue para cada página, todos los archivos adjuntos, emoticonos y archivos incrustados.

Requisitos

• declarar variables del sistema:
  • atlassianAPIToken
  • atlassianUserEmail

Dependencias

• python3
  • solicitudes
  • hermosasopa4
  • Almohada (manejar imágenes)
  • pandoc y pypandoc (convertir a RST)
  • re

Instalación

• Clonar repositorio.
• Instalar dependencias.
• Declare variables del sistema para el token API de Atlassian.

Programa en ejecución

• Cómo descargar una sola página según su ID.

 confluenceDumpWithPython.py -m single -S <site Name> -p <ID of page to dump> [<output folder>] [--sphinx]

• Cómo descargar Propiedades de página y todas las páginas contenidas.

 confluenceDumpWithPython.py -m pageprops -S <site Name> -p <ID of page properties report page> [<output folder>] [--sphinx]

• Cómo descargar un espacio completo.

 confluenceDumpWithPython.py -m space -S <site Name> -s <space KEY> [<output folder>]

Ayuda

Ningún consejo especial aparte de:

• asegúrese de que su token API de Atlassian sea válido.
• el nombre de usuario de la API de Cloud Atlassian es la dirección de correo electrónico.

Autores

Nombres de los contribuyentes e información de contacto.

@dernorberto

Mejoras

• Agregue exportación según la etiqueta de la página.
• Agregue enlaces a Descargas para las páginas correspondientes.
• Actualice todos los enlaces de las páginas descargadas a las copias locales.
• Agregue a los encabezados la página principal y las etiquetas de la página.
• Cree un índice de las páginas para usar como TOC.
• Cree un diseño de página para mostrar artículos TOC +.
• Copie styles/site.css en output/styles/ si no está presente.
• Permitir el uso con Confluence Server.

Asuntos

• No le gustan los archivos adjuntos muy largos; deberá cambiarles el nombre en Confluence antes del volcado.
• Las páginas migradas previamente desde Confluence Server pueden tener problemas con emoticones antiguos. Lo mejor es convertir las páginas al Nuevo Editor, que reemplazará los emoticones que faltan.

Historial de versiones

• 1.4
  • Refactorización en una configuración de archivos más simple ( confluenceDumpWithPython.py y myModules.py )
• 1.3
  • Exportación de espacio agregado (estructura de carpetas plana)
• 1.2
  • Se agregaron mejores encabezados y pies de página HTML.
  • Se agregaron etiquetas de página a los encabezados HTML.
  • Lógica de argumentos de carpeta de salida mejorada.
• 1.1
  • Se agregó el volcado de propiedades de Papge y otras cosas más pequeñas.
• 1.0
  • Lanzamiento inicial

legado/carpeta con la versión anterior de los scripts

Finalidad de los ficheros:

1. confluenceExportHTMLrequestsByLabel.py : descarga un conjunto de páginas basadas en una (o más) etiquetas de página.
2. confluenceExportHTMLrequestsSingle.py : descarga una sola página proporcionando el ID de la página como argumento.
3. confluenceExportHTMLrequestsPagePropertiesReport.py : descarga las propiedades de la página y todas las páginas del informe proporcionando el ID de la página como argumento.
4. confluenceExportHTMLrequestsPagesInSpace.py : descarga todas las páginas desde un espacio.

Licencia

Este proyecto tiene la licencia MIT; consulte el archivo LICENSE.txt para obtener más detalles.

Expresiones de gratitud