confluenceDumpWithPython

Python을 사용한 Confluence 덤프

내장된 그림과 첨부 파일을 포함하여 HTML 및 RST 형식의 Python(요청)을 사용하여 Confluence 페이지를 덤프합니다. 다운로드한 파일에 대한 참조는 로컬 상대 경로로 업데이트됩니다.

설명

그럼에도 불구하고 리팩토링에는 2개의 파일만 필요하며 명령줄 인수를 허용합니다.

• myModules.py : 필요한 모든 기능이 포함되어 있습니다.
• confluenceDumpWithPython.py : 다음 명령줄 인수와 함께 사용할 스크립트:
  • -m, --mode : 내보내기 모드, single , space , bylabel , pageprops (필수).
    • 참고: 지금까지 single , pageprops 및 space 만 구현되었습니다.
  • -S, --site : Atlassian 사이트(필수).
  • -s, --space : 스페이스 키(필요한 경우).
  • -p, --page : 페이지 ID(필요한 경우).
  • -l, --label : 페이지 레이블(필요한 경우).
  • -x, --sphinx : _images 및 _static 폴더는 내보낸 HTML 파일과 함께 배치되는 대신 내보내기 폴더의 루트에 배치됩니다.
  • --notags : rst 파일에 태그 지시문을 추가하지 않습니다( sphinx-tags 애드온이 사용되지 않는 경우).
• updatePageLinks.py : 지금까지 다운로드한 로컬 파일에 대한 온라인 합류 링크를 업데이트합니다.
  • --folder : 업데이트할 파일이 포함된 폴더입니다.
  • --test : 원본 .rst 파일을 덮어쓰는 대신 접두사로 zout_ 사용하여 업데이트된 파일을 생성합니다.
• getPageEditorVersion.py : 단일 페이지 또는 스페이스의 모든 페이지에서 편집기 버전을 가져옵니다.
  • --site : Atlassian 사이트(필수).
  • --page : 페이지 ID(또는)
  • --space : 스페이스 키(또는 둘 중 하나)

CSS 스타일링의 경우 https://jira.atlassian.com/browse/CONFSERVER-40907에 설명된 해결 방법을 사용하여 얻을 수 있는 Confluence의 confluence.css 사용합니다. Confluence UI HTML 내보내기에 포함된 site.css 파일은 위의 파일만큼 완전하지 않습니다.

폴더 및 파일 구조:

• 기본 출력 폴더는 스크립트와 동일한 경로 아래에 있는 output/ 입니다.
• 공간 이름, 페이지 속성 보고서 페이지, 단일 페이지 이름 또는 페이지 레이블 이름이 있는 폴더가 출력 폴더 아래에 생성됩니다.
• 기본적으로 _images/ 및 _static/ 폴더는 page|space|pageprops|label 폴더에 배치됩니다.
  • --sphinx 명령줄 옵션은 해당 폴더를 출력 폴더 바로 아래에 배치합니다.
• styles/confluence.css 파일이 정의된 _static/ 에 복사됩니다.

기능

• Confluence Cloud API 활용
• HTML 헤더 및 RST 필드에 페이지 ID 및 페이지 레이블과 같은 Confluence 메타 데이터를 넣습니다.
• beautifulsoup는 HTML을 구문 분석하여 콘텐츠를 가져오고 업데이트하는 데 사용됩니다. 원격 링크를 로컬 링크로 변경합니다.
• 모든 페이지, 모든 첨부 파일, 이모티콘 및 포함된 파일을 다운로드하세요.

요구사항

• 시스템 변수를 선언합니다.
  • atlassianAPIToken
  • atlassianUserEmail

종속성

• 파이썬3
  • 요청
  • 아름다운수프4
  • 베개(손잡이 이미지)
  • pandoc & pypandoc(RST로 변환)
  • 답장

설치 중

• 클론 저장소.
• 종속성을 설치합니다.
• Atlassian API 토큰에 대한 시스템 변수를 선언합니다.

프로그램 실행 중

• ID를 기준으로 단일 페이지를 다운로드하는 방법입니다.

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

• 페이지 속성 및 포함된 모든 페이지를 다운로드하는 방법.

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

• 전체 공간을 다운로드하는 방법.

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

돕다

다음 외에는 특별한 조언이 없습니다.

• Atlassian API 토큰이 유효한지 확인하세요.
• Cloud Atlassian API의 사용자 이름은 이메일 주소입니다.

저자

기여자 이름 및 연락처 정보

@dernorberto

개량

• 페이지 레이블을 기반으로 내보내기를 추가합니다.
• 해당 페이지에 대한 다운로드 링크를 추가합니다.
• 다운로드한 페이지의 모든 링크를 로컬 복사본으로 업데이트합니다.
• 상위 페이지와 페이지 레이블을 헤더에 추가합니다.
• 목차로 사용할 페이지의 색인을 만듭니다.
• TOC + 기사를 표시하는 페이지 레이아웃을 만듭니다.
• styles/site.css 없으면 output/styles/ 에 복사합니다.
• Confluence Server와 함께 사용하도록 허용합니다.

문제

• 매우 긴 첨부 파일을 좋아하지 않으므로 덤프하기 전에 Confluence에서 이름을 바꿔야 합니다.
• 이전에 Confluence Server에서 마이그레이션된 페이지에는 이전 이모티콘에 문제가 있을 수 있습니다. 가장 좋은 방법은 누락된 이모티콘을 대체하는 새 편집기로 페이지를 변환하는 것입니다.

버전 기록

• 1.4
  • 보다 간단한 파일 설정으로 리팩터링( confluenceDumpWithPython.py & myModules.py )
• 1.3
  • 공간 내보내기 추가(플랫 폴더 구조)
• 1.2
  • 더 나은 HTML 머리글과 바닥글이 추가되었습니다.
  • HTML 헤더에 페이지 레이블을 추가했습니다.
  • 출력 폴더 인수 논리가 개선되었습니다.
• 1.1
  • Pagege Properties 덤프 및 기타 작은 항목을 추가했습니다.
• 1.0
  • 최초 출시

이전 버전의 스크립트가 있는 Legacy/ 폴더

파일의 목적:

1. confluenceExportHTMLrequestsByLabel.py : 하나 이상의 페이지 라벨을 기반으로 페이지 세트를 다운로드합니다.
2. confluenceExportHTMLrequestsSingle.py : 페이지 ID를 인수로 제공하여 단일 페이지를 다운로드합니다.
3. confluenceExportHTMLrequestsPagePropertiesReport.py : 페이지 ID를 인수로 제공하여 보고서의 페이지 속성과 모든 페이지를 다운로드합니다.
4. confluenceExportHTMLrequestsPagesInSpace.py : 공간에서 모든 페이지를 다운로드합니다.

특허

이 프로젝트는 MIT 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 LICENSE.txt 파일을 참조하세요.

감사의 말