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. 將其移至bin目錄/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. 從Github到本地存儲庫的Clone Sklearn：

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

3. 使用pyreverse生成包裝架構圖作為UML

 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

使用Web-browser打開index.html ：

分配和貢獻

該項目是根據麻省理工學院許可證分發的 - 隨時隨意使用它。

請打開GitHub問題和/或PR，並提供更改建議進行協作。