pyarch

Pyarch

Alat untuk menghasilkan diagram kelas dinamis paket Python untuk memfasilitasi pengembangan dan pemeliharaan mereka.

Motivasi :

• Pengurangan beban kognitif saat mempelajari struktur paket baru.
• Identifikasi kemacetan arsitektur menggunakan analisis statis ketergantungan antar-modular.

Demo

• Sklearn
• Superduperdb
• Sanic
• Fastapi

Tindakan GitHub

Pyarch dapat dieksekusi sebagai bagian dari alur kerja GitHub.

Input

Atribut	Keterangan	Diperlukan	Bawaan
input	Direktori dengan kode sumber paket	BENAR
output	Direktori untuk menyimpan file html yang dihasilkan	PALSU	.pyarch/output
title	Judul HTML Kustom	PALSU	Python package architecture
header	Header html khusus	PALSU	Python package architecture
footer	Footer html khusus	PALSU	<p style="font-size:15px">Built with ❤️ by <a href="https://www.dkisler.com" target=_blank>Dmitry Kisler - dkisler.com</a></p>

Output

• output : Path to Diberikan File HTML.

Contoh: Penyebaran Diagram Arsitektur Paket ke Halaman GitHub

Alur kerja GitHub berikut dapat digunakan untuk menghasilkan diagram arsitektur paket dan untuk mempublikasikannya menggunakan halaman 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 

Mandiri

Cara menginstal

Prasyarat :

• Python> = 3.8

Tangga

1. Unduh rilis terbaru dari skrip Python
2. Pindahkan ke Direktori Bin /usr/local/bin
3. Jalankan skrip untuk memvalidasi versi:

 pyarch --version

Perhatikan bahwa izin sudo akan diperlukan. Atau, skrip dapat dieksekusi tanpa step 2 :

 python3 pyarch --version

Demo

Catatan Cat diperlukan.

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

Keluaran:

 version: 0.0.1

Cara menggunakan

Prasyarat :

• Pylint
• Pyarch

Ikuti langkah -langkah untuk menghasilkan halaman web dengan diagram arsitektur dinamis Sklearn:

1. Buat direktori yang bersih

 mkdir sklearn-diagram && cd sklearn-diagram 

2. Klon SKLEARN DARI GITHUB ke Repositori Lokal:

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

3. Menghasilkan diagram arsitektur paket sebagai UML menggunakan pyreverse

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

4. Hasilkan halaman web dengan diagram dinamis:

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

Direktori diharapkan memiliki struktur berikut:

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

Buka index.html menggunakan browser web:

Distribusi dan kontribusi

Proyek ini didistribusikan di bawah lisensi MIT - jangan ragu untuk menggunakannya seperti yang Anda inginkan.

Harap buka masalah GitHub, dan/atau PR dengan proposal perubahan untuk berkolaborasi.