confluenceDumpWithPython

การบรรจบกันการถ่ายโอนข้อมูลด้วย Python

ดัมพ์หน้าบรรจบกันโดยใช้ Python (คำขอ) ในรูปแบบ HTML และ RST รวมถึงรูปภาพและไฟล์แนบที่ฝังไว้ การอ้างอิงไฟล์ที่ดาวน์โหลดจะได้รับการอัปเดตเป็นพาธแบบสัมพันธ์ในเครื่อง

คำอธิบาย

อย่างไรก็ตาม การรีแฟคเตอร์ต้องใช้เพียง 2 ไฟล์และยอมรับ args บรรทัดคำสั่ง:

• myModules.py : ประกอบด้วยฟังก์ชันที่จำเป็นทั้งหมด
• confluenceDumpWithPython.py : สคริปต์ที่จะใช้กับ args บรรทัดคำสั่งต่อไปนี้:
  • -m, --mode : โหมดการส่งออก, single , space , bylabel , pageprops (จำเป็น)
    • หมายเหตุ: จนถึงตอนนี้มีเพียง single , pageprops และ space เท่านั้นที่ถูกใช้งาน
  • -S, --site : ไซต์ Atlassian (จำเป็น)
  • -s, --space : ปุ่ม Space (หากจำเป็น)
  • -p, --page : Page ID (ถ้าจำเป็น)
  • -l, --label : ป้ายกำกับเพจ (หากจำเป็น)
  • -x, --sphinx : โฟลเดอร์ _images และ _static จะถูกวางไว้ที่รากของโฟลเดอร์ส่งออก แทนที่จะอยู่ร่วมกับไฟล์ HTML ที่ส่งออก
  • --notags : ไม่เพิ่มคำสั่งแท็กให้กับไฟล์แรก (เมื่อไม่ได้ใช้ addon sphinx-tags )
• updatePageLinks.py : อัปเดตลิงก์ที่บรรจบกันออนไลน์ไปยังไฟล์ในเครื่องที่ดาวน์โหลดมาแล้ว
  • --folder : โฟลเดอร์ที่มีไฟล์ที่จะอัพเดต
  • --test : แทนที่จะเขียนทับไฟล์ .rst ต้นฉบับ ไฟล์จะสร้างไฟล์ที่อัปเดตโดยมี zout_ เป็นคำนำหน้า
• getPageEditorVersion.py : รับเวอร์ชันตัวแก้ไขจากหน้าเดียวหรือทุกหน้าในพื้นที่
  • --site : ไซต์ Atlassian (จำเป็น)
  • --page : รหัสหน้า (อย่างใดอย่างหนึ่ง/หรือ)
  • --space : Space Key (อย่างใดอย่างหนึ่ง/หรือ)

สำหรับการจัดสไตล์ CSS นั้นจะใช้ confluence.css จาก Confluence ซึ่งสามารถรับได้โดยใช้วิธีแก้ปัญหาที่อธิบายไว้ใน: https://jira.atlassian.com/browse/CONFSERVER-40907 ไฟล์ site.css ที่รวมอยู่ในการส่งออก HTML ของ Confluence UI นั้นไม่สมบูรณ์เหมือนกับไฟล์ด้านบน

โครงสร้างโฟลเดอร์และไฟล์:

• โฟลเดอร์เอาต์พุตเริ่มต้นคือ output/ ภายใต้พาธเดียวกันกับสคริปต์
• โฟลเดอร์ที่มีชื่อ Space, หน้ารายงานคุณสมบัติของเพจ, ชื่อเพจเดียว หรือชื่อป้ายกำกับเพจจะถูกสร้างขึ้นภายใต้โฟลเดอร์เอาต์พุต
• ตามค่าเริ่มต้น โฟลเดอร์ _images/ และ _static/ จะถูกวางไว้ในโฟลเดอร์ page|space|pageprops|label
  • ตัวเลือกบรรทัดคำสั่ง --sphinx จะวางโฟลเดอร์เหล่านั้นไว้ใต้โฟลเดอร์เอาต์พุตโดยตรง
• ไฟล์ styles/confluence.css จะถูกคัดลอกไปยัง _static/ ที่กำหนดไว้

มันทำอะไร

• ใช้ประโยชน์จาก Confluence Cloud API
• วางข้อมูลเมตา Confluence เช่น Page ID และ Page Labels ในส่วนหัว HTML และฟิลด์ RST
• beautifulsoup ใช้เพื่อแยกวิเคราะห์ HTML เพื่อรับและอัปเดตเนื้อหา เช่น เปลี่ยนลิงก์ระยะไกลเป็นลิงก์ท้องถิ่น
• ดาวน์โหลดสำหรับทุกหน้า ไฟล์แนบ อีโมติคอน และไฟล์ที่ฝังทั้งหมด

ความต้องการ

• ประกาศตัวแปรระบบ:
  • atlassianAPIToken
  • atlassianUserEmail

การพึ่งพาอาศัยกัน

• หลาม3
  • คำขอ
  • ซุปสวย4
  • หมอน (จับรูป)
  • pandoc & pypandoc (แปลงเป็น RST)
  • อีกครั้ง

กำลังติดตั้ง

• โคลน repo
• ติดตั้งการพึ่งพา
• ประกาศตัวแปรระบบสำหรับโทเค็น Atlassian API

กำลังดำเนินการโปรแกรม

• วิธีดาวน์โหลดหน้าเดียวตาม ID

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

• วิธีดาวน์โหลดคุณสมบัติของเพจและเพจที่มีอยู่ทั้งหมด

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

• วิธีดาวน์โหลด Space ทั้งหมด

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

ช่วย

ไม่มีคำแนะนำพิเศษอื่นใดนอกจาก:

• ตรวจสอบให้แน่ใจว่าโทเค็น Atlassian API ของคุณถูกต้อง
• ชื่อผู้ใช้สำหรับ Cloud Atlassian API คือที่อยู่อีเมล

ผู้เขียน

ชื่อผู้ร่วมให้ข้อมูลและข้อมูลการติดต่อ

@dernorberto

การปรับปรุง

• เพิ่มการส่งออกตามป้ายกำกับหน้า
• เพิ่มลิงก์ไปยังดาวน์โหลดสำหรับหน้าที่เกี่ยวข้อง
• อัปเดตลิงก์ทั้งหมดจากหน้าที่ดาวน์โหลดไปยังสำเนาในเครื่อง
• เพิ่มไปยังส่วนหัวของเพจหลักและป้ายกำกับเพจ
• สร้างดัชนีของเพจเพื่อใช้เป็น TOC
• สร้างเค้าโครงหน้าเพื่อแสดง TOC + บทความ
• คัดลอก styles/site.css ลงใน output/styles/ หากไม่มี
• อนุญาตให้ใช้กับ Confluence Server

ปัญหา

• ไม่ชอบไฟล์แนบที่ยาวมาก คุณจะต้องเปลี่ยนชื่อไฟล์เหล่านั้นใน Confluence ก่อนที่จะถ่ายโอนข้อมูล
• เพจที่ย้ายก่อนหน้านี้จาก Confluence Server อาจมีปัญหากับอิโมติคอนเก่า วิธีที่ดีที่สุดคือการแปลงหน้าต่างๆ เป็นตัวแก้ไขใหม่ ซึ่งจะแทนที่อิโมติคอนที่หายไป

ประวัติเวอร์ชัน

• 1.4
  • การปรับโครงสร้างใหม่เป็นการตั้งค่าไฟล์ที่ง่ายขึ้น ( confluenceDumpWithPython.py & myModules.py )
• 1.3
  • เพิ่มการส่งออก Space (โครงสร้างโฟลเดอร์แบบเรียบ)
• 1.2
  • เพิ่มส่วนหัวและส่วนท้าย HTML ที่ดีขึ้น
  • เพิ่มป้ายกำกับหน้าให้กับส่วนหัว HTML
  • ปรับปรุงตรรกะอาร์กิวเมนต์ของโฟลเดอร์เอาต์พุต
• 1.1
  • เพิ่มดัมพ์ของ Papge Properties และของเล็กๆ น้อยๆ อื่นๆ
• 1.0
  • การเปิดตัวครั้งแรก

ดั้งเดิม/ โฟลเดอร์ที่มีสคริปต์เวอร์ชันก่อนหน้า

วัตถุประสงค์ของไฟล์:

1. confluenceExportHTMLrequestsByLabel.py : ดาวน์โหลดชุดของเพจตามป้ายกำกับหน้าหนึ่ง (หรือมากกว่า)
2. confluenceExportHTMLrequestsSingle.py : ดาวน์โหลดหน้าเดียวโดยระบุ ID ของหน้าเป็นอาร์กิวเมนต์
3. confluenceExportHTMLrequestsPagePropertiesReport.py : ดาวน์โหลดคุณสมบัติของเพจและเพจทั้งหมดในรายงานโดยระบุ ID เพจเป็นอาร์กิวเมนต์
4. confluenceExportHTMLrequestsPagesInSpace.py : ดาวน์โหลดหน้าทั้งหมดจากช่องว่าง

ใบอนุญาต

โครงการนี้ได้รับอนุญาตภายใต้ใบอนุญาต MIT - ดูรายละเอียดในไฟล์ LICENSE.txt

รับทราบ