слияниеDumpWithPython

Дамп Confluence с Python

Дамп страниц Confluence с использованием Python (запросов) в формате HTML и RST, включая встроенные изображения и вложения. Ссылки на загруженные файлы будут обновлены до их локального относительного пути.

Описание

Тем не менее, для рефакторинга потребуется всего 2 файла и принимать аргументы командной строки:

• myModules.py : содержит все необходимые функции.
• confluenceDumpWithPython.py : скрипт для использования со следующими аргументами командной строки:
  • -m, --mode : режим экспорта: single , space , bylabel , pageprops (обязательно).
    • Примечание. На данный момент реализованы только single , pageprops и space .
  • -S, --site : сайт Atlassian (обязательно).
  • -s, --space : клавиша пробела (при необходимости).
  • -p, --page : идентификатор страницы (при необходимости).
  • -l, --label : метка страницы (при необходимости).
  • -x, --sphinx : папки _images и _static размещаются в корне папки экспорта, а не вместе с экспортированными файлами HTML.
  • --notags : не добавляет директивы тегов в первые файлы (если не используется дополнение sphinx-tags ).
• updatePageLinks.py : обновляет онлайн-ссылки слияния на локальные файлы, которые были загружены на данный момент.
  • --folder : папка, содержащая файлы для обновления.
  • --test : вместо перезаписи исходных файлов .rst будут созданы обновленные файлы с префиксом zout_ .
• getPageEditorVersion.py : Получите версию редактора для отдельных страниц или всех страниц в пространстве.
  • --site : сайт Atlassian (обязательно).
  • --page : ID страницы (или/или)
  • --space : клавиша пробела (или/или)

Для стилизации CSS используется файл confluence.css из Confluence, который можно получить с помощью обходного пути, описанного в: https://jira.atlassian.com/browse/CONFSERVER-40907. Файл site.css , включенный в экспорт HTML пользовательского интерфейса Confluence, не такой полный, как приведенный выше.

Структура папок и файлов:

• Папка вывода по умолчанию — output/ по тому же пути, что и сценарий.
• В выходной папке будет создана папка с именем пространства, страницей отчета «Свойства страницы», именем отдельной страницы или именем метки страницы.
• По умолчанию папки _images/ и _static/ будут помещены в папку page|space|pageprops|label.
  • Параметр командной строки --sphinx поместит эту папку непосредственно в выходную папку.
• Файл styles/confluence.css будет скопирован в определенный каталог _static/

Что он делает

• Использует API Confluence Cloud.
• Помещает метаданные Confluence, такие как идентификатор страницы и метки страницы, в заголовки HTML и поля RST.
• beautifulsoup используется для анализа HTML с целью получения и обновления контента, т.е. изменить удаленные ссылки на локальные.
• Скачивайте для каждой страницы все вложения, смайлы и встроенные файлы.

Требования

• объявить системные переменные:
  • atlassianAPIToken
  • atlassianUserEmail

Зависимости

• python3
  • запросы
  • красивыйсуп4
  • Подушка (обработка изображений)
  • pandoc и pypandoc (конвертировать в RST)
  • ре

Установка

• Клон репо.
• Установите зависимости.
• Объявите системные переменные для токена Atlassian API.

Выполнение программы

• Как загрузить одну страницу по ее идентификатору.

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

• Как загрузить свойства страницы и все содержащиеся в ней страницы.

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

• Как скачать весь Space.

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

Помощь

Никаких особых советов, кроме:

• убедитесь, что ваш токен Atlassian API действителен.
• именем пользователя Cloud Atlassian API является адрес электронной почты.

Авторы

Имена авторов и контактная информация

@dernorberto

Улучшения

• Добавьте экспорт на основе метки страницы.
• Добавьте ссылки на загрузки для соответствующих страниц.
• Обновите все ссылки со загруженных страниц на локальные копии.
• Добавьте в заголовки родительскую страницу и метки страниц.
• Создайте индекс страниц, который будет использоваться в качестве оглавления.
• Создайте макет страницы для отображения содержания и статей.
• Скопируйте styles/site.css в output/styles/ если он отсутствует.
• Разрешить использование с Confluence Server.

Проблемы

• Он не любит очень длинные вложенные файлы, перед дампом их нужно будет переименовать в Confluence.
• На страницах, ранее перенесенных с сервера Confluence, могут возникнуть проблемы со старыми смайлами. Лучше всего конвертировать страницы в Новый редактор, который заменит отсутствующие смайлы.

История версий

• 1,4
  • Рефакторинг в более простую настройку файла ( confluenceDumpWithPython.py и myModules.py )
• 1.3
  • Добавлен экспорт пространства (плоская структура папок).
• 1.2
  • Добавлен улучшенный верхний и нижний колонтитул HTML.
  • Добавлены метки страниц в заголовки HTML.
  • Улучшена логика аргументов выходной папки.
• 1.1
  • Добавлен дамп свойств страницы и другие мелочи.
• 1.0
  • Первоначальный выпуск

Legacy/папка с предыдущей версией скриптов

Назначение файлов:

1. confluenceExportHTMLrequestsByLabel.py : загрузите набор страниц на основе одной (или нескольких) меток страниц.
2. confluenceExportHTMLrequestsSingle.py : загрузите одну страницу, указав идентификатор страницы в качестве аргумента.
3. confluenceExportHTMLrequestsPagePropertiesReport.py : загрузите свойства страницы и все страницы в отчете, указав идентификатор страницы в качестве аргумента.
4. confluenceExportHTMLrequestsPagesInSpace.py : загрузить все страницы из пространства.

Лицензия

Этот проект лицензируется по лицензии MIT — подробности см. в файле LICENSE.txt.

Благодарности