confluenceDumpWithPython

Despejo do Confluence com Python

Despeja páginas do Confluence usando Python (solicitações) em formato HTML e RST, incluindo imagens incorporadas e anexos. As referências aos arquivos baixados serão atualizadas para o caminho relativo local.

Descrição

No entanto, a refatoração exigirá apenas 2 arquivos e aceitará argumentos de linha de comando:

• myModules.py : contém todas as funções necessárias.
• confluenceDumpWithPython.py : Script para usar com os seguintes argumentos de linha de comando:
  • -m, --mode : O modo de exportação, single , space , bylabel , pageprops (obrigatório).
    • Nota: Apenas single , pageprops e space foram implementados até agora.
  • -S, --site : O site Atlassian (obrigatório).
  • -s, --space : A tecla de espaço (se necessário).
  • -p, --page : o ID da página (se necessário).
  • -l, --label : o rótulo da página (se necessário).
  • -x, --sphinx : As pastas _images e _static são colocadas na raiz da pasta de exportação, em vez de junto com os arquivos HTML exportados.
  • --notags : Não adiciona as diretivas tags aos primeiros arquivos (quando o complemento sphinx-tags não é usado).
• updatePageLinks.py : Atualize os links do Confluence on-line para os arquivos locais que foram baixados até o momento.
  • --folder : Pasta contendo os arquivos a serem atualizados.
  • --test : Em vez de substituir os arquivos .rst originais, ele criará arquivos atualizados com zout_ como prefixo.
• getPageEditorVersion.py : obtém a versão do editor de páginas únicas ou de todas as páginas em um espaço.
  • --site : O site Atlassian (obrigatório).
  • --page : ID da página (ou/ou)
  • --space : Tecla de espaço (ou/ou)

Para estilo CSS, ele usa o confluence.css do Confluence que pode ser obtido usando a solução alternativa descrita em: https://jira.atlassian.com/browse/CONFSERVER-40907. O arquivo site.css incluído nas exportações HTML da UI do Confluence não é tão completo quanto o acima.

Estrutura de pastas e arquivos:

• A pasta de saída padrão é output/ no mesmo caminho do script.
• Uma pasta com o nome do espaço, página do relatório Propriedades da página, nome de página única ou nome do rótulo da página será criada na pasta de saída.
• Por padrão, as pastas _images/ e _static/ serão colocadas na pasta page|space|pageprops|label.
  • A opção de linha de comando --sphinx colocará essas pastas diretamente sob a pasta de saída
• O arquivo styles/confluence.css será copiado para o arquivo _static/ definido

O que isso faz

• Aproveita a API Confluence Cloud
• Coloca metadados do Confluence, como ID da página e rótulos da página, nos cabeçalhos HTML e campos RST.
• beautifulsoup é usado para analisar HTML para obter e atualizar conteúdo, ou seja. alterar links remotos para links locais.
• Baixe para cada página, todos os anexos, emoticons e arquivos incorporados.

Requisitos

• declare variáveis ​​do sistema:
  • atlassianAPIToken
  • atlassianUserEmail

Dependências

• python3
  • solicitações
  • lindasopa4
  • Almofada (imagens de alça)
  • pandoc e pypandoc (converter para RST)
  • ré

Instalando

• Clonar repositório.
• Instale dependências.
• Declare variáveis ​​de sistema para o token de API Atlassian.

Executando programa

• Como baixar uma única página com base em seu ID.

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

• Como baixar as propriedades da página e todas as páginas contidas.

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

• Como baixar um espaço inteiro.

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

Ajuda

Nenhum conselho especial além de:

• certifique-se de que seu token de API Atlassian seja válido.
• o nome de usuário da API Cloud Atlassian é o endereço de e-mail.

Autores

Nomes dos colaboradores e informações de contato

@dernorberto

Melhorias

• Adicione exportação com base no rótulo da página.
• Adicione links para downloads nas páginas correspondentes.
• Atualize todos os links das páginas baixadas para as cópias locais.
• Adicione aos cabeçalhos a página pai e os rótulos da página.
• Crie um índice das páginas para usar como sumário.
• Crie um layout de página para exibir artigos do TOC +.
• Copie styles/site.css em output/styles/ se não estiver presente.
• Permitir uso com Confluence Server.

Problemas

• Ele não gosta de arquivos anexos muito longos; você precisará renomeá-los no Confluence antes de despejá-los.
• As páginas migradas anteriormente do Confluence Server podem ter problemas com emoticons antigos. O melhor é converter as páginas para o Novo Editor, que substituirá os emoticons faltantes.

Histórico de versões

• 1.4
  • Refatorando em uma configuração de arquivo mais simples ( confluenceDumpWithPython.py & myModules.py )
• 1.3
  • Adicionada exportação de espaço (estrutura de pasta plana)
• 1.2
  • Adicionado melhor cabeçalho e rodapé HTML.
  • Adicionados rótulos de página aos cabeçalhos HTML.
  • Lógica de argumento da pasta de saída aprimorada.
• 1.1
  • Adicionado despejo de propriedades do Papge e outras coisas menores
• 1,0
  • Lançamento Inicial

legado/pasta com versão anterior dos scripts

Finalidade dos arquivos:

1. confluenceExportHTMLrequestsByLabel.py : baixe um conjunto de páginas com base em um (ou mais) rótulos de página.
2. confluenceExportHTMLrequestsSingle.py : baixe uma única página fornecendo o ID da página como argumento.
3. confluenceExportHTMLrequestsPagePropertiesReport.py : baixe as propriedades da página e todas as páginas do relatório fornecendo o ID da página como argumento.
4. confluenceExportHTMLrequestsPagesInSpace.py : baixe todas as páginas de um espaço.

Licença

Este projeto está licenciado sob a licença MIT - consulte o arquivo LICENSE.txt para obter detalhes

Agradecimentos