pyarch

pyarch

เครื่องมือในการสร้างไดอะแกรมคลาสแบบไดนามิกของแพ็คเกจ Python เพื่ออำนวยความสะดวกในการพัฒนาและบำรุงรักษา

แรงจูงใจ :

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

การสาธิต

• Sklearn
• superduperdb
• เกี่ยวกับนิค
• Fastapi

การกระทำของ GitHub

Pyarch สามารถดำเนินการเป็นส่วนหนึ่งของเวิร์กโฟลว์ GitHub

อินพุต

คุณลักษณะ	คำอธิบาย	ที่จำเป็น	ค่าเริ่มต้น
input	ไดเรกทอรีด้วยซอร์สโค้ดแพ็คเกจ	จริง
output	ไดเรกทอรีเพื่อบันทึกไฟล์ HTML ที่สร้างขึ้น	เท็จ	.pyarch/output
title	ชื่อ HTML ที่กำหนดเอง	เท็จ	Python package architecture
header	ส่วนหัว HTML ที่กำหนดเอง	เท็จ	Python package architecture
footer	ส่วนท้าย HTML ที่กำหนดเอง	เท็จ	<p style="font-size:15px">Built with ❤️ by <a href="https://www.dkisler.com" target=_blank>Dmitry Kisler - dkisler.com</a></p>

เอาต์พุต

• output : พา ธ ไปยังไฟล์ HTML ที่สร้างขึ้น

ตัวอย่าง: การปรับใช้ไดอะแกรมสถาปัตยกรรมแพ็คเกจไปยังหน้า GitHub

เวิร์กโฟลว์ GitHub ต่อไปนี้สามารถใช้เพื่อสร้างแผนภาพสถาปัตยกรรมแพ็คเกจและเผยแพร่โดยใช้หน้า GitHub

 name : " Pyarch Pages "

on :
  workflow_dispatch :

permissions :
  contents : read
  pages : write
  id-token : write

concurrency :
  group : " pages "
  cancel-in-progress : false

jobs :
  pyarch-pages :
    runs-on : ubuntu-20.04
    steps :
      # assumption: the workflow is running in the python package repo
      - uses : actions/checkout@v3
        with :
          fetch-depth : 0

      - name : Generate HTML
        uses : kislerdm/[email protected]
        with :
          # Change to the path with the package's source files
          input : src
          title : " Architecture of my package "
          header : " Architecture of my package "
          output : public

      - name : Setup Pages
        uses : actions/configure-pages@v3
      - name : Upload artifact
        uses : actions/upload-pages-artifact@v2
        with :
          path : ' public '
      - name : Deploy to GitHub Pages
        id : deployment
        uses : actions/deploy-pages@v2 

แบบสแตนด์อโลน

วิธีการติดตั้ง

ข้อกำหนดเบื้องต้น :

• Python> = 3.8

ขั้นตอน

1. ดาวน์โหลดสคริปต์ Python ล่าสุด
2. ย้ายไปที่ไดเรกทอรีถัง /usr/local/bin
3. เรียกใช้สคริปต์เพื่อตรวจสอบเวอร์ชัน:

 pyarch --version

โปรดทราบ ว่าจะต้องมีการอนุญาต Sudo อีกทางเลือกหนึ่งสคริปต์สามารถดำเนินการได้โดยไม่ต้อง step 2 :

 python3 pyarch --version

การสาธิต

จำเป็นต้องมี หมายเหตุ ม้วน

 sudo curl -SLo /usr/local/bin/pyarch https://github.com/kislerdm/pyarch/releases/download/v0.0.1/pyarch &&
pyarch --version

เอาท์พุท:

 version: 0.0.1

วิธีใช้

ข้อกำหนดเบื้องต้น :

• ไพลินต์
• pyarch

ทำตามขั้นตอนในการสร้างหน้าเว็บด้วยไดอะแกรมสถาปัตยกรรมแบบไดนามิกของ Sklearn:

1. สร้างไดเรกทอรีที่สะอาด

 mkdir sklearn-diagram && cd sklearn-diagram 

2. Clone Sklearn จาก GitHub ไปยังที่เก็บท้องถิ่น:

 git clone [email protected]:scikit-learn/scikit-learn.git code

3. สร้างไดอะแกรมสถาปัตยกรรมแพ็คเกจเป็น UML โดยใช้ Pyreverse

 pyreverse -Akmy -o puml -d . --ignore=test,tests code/sklearn

4. สร้างหน้าเว็บด้วยไดอะแกรมแบบไดนามิก:

 pyarch -i . -o . -v --title="sklearn architecture" --header="sklearn architecture"

ไดเรกทอรีคาดว่าจะมีโครงสร้างดังต่อไปนี้:

 .
├── code
├── classes.puml
├── packages.puml
└── index.html

เปิด index.html โดยใช้เว็บเบราว์เซอร์:

การกระจายและการบริจาค

โครงการจัดจำหน่ายภายใต้ใบอนุญาต MIT - อย่าลังเลที่จะใช้งานตามที่คุณต้องการ

โปรดเปิดปัญหา GitHub และ/หรือ PR พร้อมข้อเสนอการเปลี่ยนแปลงเพื่อทำงานร่วมกัน