pyarch

بيارك

الأداة لإنشاء مخططات فئة ديناميكية من حزم بيثون لتسهيل تطويرها وصيانتها.

تحفيز :

• الحد من الحمل المعرفي عند تعلم بنية حزمة جديدة.
• تحديد اختناقات الهندسة المعمارية باستخدام التحليل الثابت للاعتمادات بين الخلايا.

العرض التوضيحي

• Sklearn
• superduperdb
• سانيك
• fastapi

عمل جيثب

يمكن تنفيذ 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 

مستقل

كيفية التثبيت

المتطلبات الأساسية :

• بيثون> = 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

كيفية استخدام

المتطلبات الأساسية :

• بيلنت
• بيارك

اتبع الخطوات لإنشاء صفحة الويب مع مخططات بنية ديناميكية من Sklearn:

1. إنشاء دليل نظيف

 mkdir sklearn-diagram && cd sklearn-diagram 

2. استنساخ 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 باستخدام متصفح الويب:

التوزيع والمساهمة

يتم توزيع المشروع بموجب ترخيص معهد ماساتشوستس للتكنولوجيا - لا تتردد في استخدامه كما تفعل.

يرجى فتح مشكلة github ، و/أو العلاقات العامة مع اقتراح تغيير للتعاون.