Skip to main content

Deterministic control-plane for bounded software-quality loops.

Project description

Loop Engineering

PyPI Python License: MIT

نصب نسخهٔ منتشرشده:

python -m pip install loop-engineering

این مخزن چارچوب مهندسی لوپ‌های عامل‌محور و چندعاملی برای افزایش کیفیت محصولات ساخته‌شده با وایب‌کدینگ است.

هدف، تولید بیشترین حجم کد یا بیشترین تعداد اجرای عامل نیست. هدف، ساخت سامانه‌هایی است که تغییرات کوچک، قابل‌اندازه‌گیری، قابل‌بازبینی و قابل بازگردانی ایجاد کنند و مالکیت انسانی محصول را حفظ کنند.

استفاده به‌عنوان محصول

نسخهٔ محصولی می‌تواند یک پروژهٔ دیگر را بدون انتقال کد آن پروژه و در حالت فقط‌خواندنی بررسی کند. نصب توسعه‌ای در این مخزن:

python -m venv .venv
.\.venv\Scripts\python.exe -m pip install -e .

راه‌اندازی روی هر پروژهٔ محلی:

loop-engineering init C:\path\to\project
loop-engineering doctor C:\path\to\project\.loop-engineering\inspection.yaml
loop-engineering run C:\path\to\project\.loop-engineering\inspection.yaml
loop-engineering reports C:\path\to\project\.loop-engineering\inspection.yaml --open

فرمان init فناوری‌های اعلام‌شدهٔ پروژه را بدون اجرای کد آن تشخیص می‌دهد و پروفایلی قابل‌حمل با مسیر نسبی می‌سازد. فرمان doctor پیش‌نیازها را کنترل می‌کند. فرمان run شواهد JSON، Markdown و HTML را بیرون از مخزن هدف در پوشهٔ وضعیت کاربر ذخیره می‌کند. فرمان reports نمای فهرست اجراها را می‌سازد.

برای تولید گیت‌های مستقل GitHub Actions:

loop-engineering github C:\path\to\project\.loop-engineering\inspection.yaml

فایل موجود بدون گزینهٔ صریح زیر بازنویسی نمی‌شود:

--force

شرح معماری محصول:

رابط خط فرمان قابل‌استفادهٔ مجدد

راهنمای عملیاتی:

راه‌اندازی محصول Loop Engineering

از کجا شروع کنیم

برای آشنایی و طراحی یک لوپ جدید، اسناد را به این ترتیب بخوانید:

  1. مبنای فکری استخراج‌شده از ویدیو:

    مهندسی لوپ از اصول پایه

  2. تصمیم معماری پذیرفته‌شده:

    تصمیم ۰۰۰۱: معماری کنترل‌لوپ‌محور

  3. اجزا و مرزهای معماری:

    معماری مرجع لوپ‌های چندعاملی

  4. قرارداد الزامی هر لوپ:

    قرارداد تعریف و اجرای لوپ

  5. کنترل کیفیت، ریسک و توقف:

    گیت‌های کیفیت و سیاست ریسک

  6. راه‌اندازی و بهره‌برداری:

    چرخهٔ عمر عملیاتی لوپ

  7. پیاده‌سازی مرحلهٔ اول مشاهدهٔ وب‌اپ:

    معماری مشاهدهٔ فقط‌خواندنی

  8. مرجع ماژول‌های پایتون:

    مرجع صفحهٔ کنترل پایتونی

ساختار مخزن

.
├── AGENTS.md
├── README.md
├── config/
│   └── portfolio.yaml
├── docs/
│   ├── api/
│   ├── architecture/
│   ├── decisions/
│   ├── foundations/
│   ├── operations/
│   └── standards/
├── loops/
│   ├── README.md
│   └── webapp-quality-observer/
├── pyproject.toml
├── requirements-dev.txt
├── schemas/
│   ├── inspection-profile.schema.json
│   ├── inspection-report.schema.json
│   ├── loop-definition.schema.json
│   └── portfolio.schema.json
├── scripts/
│   ├── run_inspection.py
│   └── validate_loop.py
├── src/
│   └── loop_engineering/
├── tests/
└── templates/
    └── loop/
        ├── feedback.md
        ├── golden-patterns.md
        ├── iteration-report.md
        ├── loop.yaml
        ├── runbook.md
        └── skill.md

هر لوپ واقعی در مسیر زیر قرار می‌گیرد:

loops/<loop-id>/

ساخت یک لوپ جدید

  1. بستهٔ زیر را کپی کنید:

    templates/loop/

  2. مقصد را با شناسهٔ یکتای لوپ بسازید:

    loops/<loop-id>/

  3. فایل تعریف را تکمیل و با شِما اعتبارسنجی کنید:

    schemas/loop-definition.schema.json

    پس از آماده‌سازی وابستگی‌های توسعه، فرمان مرجع اعتبارسنجی چنین است:

    python -m pip install -r requirements-dev.txt
    python scripts/validate_loop.py loops/<loop-id>/loop.yaml
    

    برای بررسی قالب پایه و همهٔ لوپ‌ها:

    python scripts/validate_loop.py --all
    
  4. حسگر و خط پایه را پیش از فعال‌کردن عامل اثبات کنید.

  5. لوپ را ابتدا در حالت مشاهده‌ای اجرا کنید.

  6. پس از تأیید خروجی‌های محدود، آن را به‌تدریج فعال کنید.

شرح کامل این فرایند در سند چرخهٔ عمر آمده است.

ترتیب اعتبار اسناد

اگر میان اسناد تعارضی وجود داشت، این ترتیب حاکم است:

  1. تصمیم‌های معماری پذیرفته‌شده؛
  2. استانداردهای پروژه؛
  3. تعریف نسخه‌بندی‌شدهٔ همان لوپ؛
  4. ران‌بوک و مهارت همان لوپ؛
  5. اسناد مبنا و یادداشت‌های منبع.

فایل بازخورد می‌تواند رفتار آیندهٔ یک لوپ را دقیق‌تر کند، اما حق نقض استانداردها، گیت‌های ریسک یا تصمیم‌های معماری را ندارد.

اصول غیرقابل چشم‌پوشی

  • ابزار قطعی بر عامل زبانی مقدم است.
  • هر تکرار باید محدود و قابل‌اندازه‌گیری باشد.
  • ارزیابی نباید فقط در اختیار عامل اعمال‌کنندهٔ تغییر باشد.
  • خروجی بازبینی‌نشده نباید بدون حد انباشته شود.
  • خودکارسازی با شواهد پایداری افزایش می‌یابد، نه با اعتماد اولیه.
  • انسان برای ادغام تغییرات محصول، مالک نهایی باقی می‌ماند مگر اینکه یک تصمیم معماری دامنهٔ کم‌ریسک مشخصی را صریحاً مستثنا کند.

وضعیت فعلی

این مخزن اکنون افزون بر بستهٔ پایه، موتور مشاهدهٔ فقط‌خواندنی و پروفایل اثبات‌شدهٔ محصول Sana را دارد. بازرسی‌های Django، پایگاه‌داده، TypeScript، ساخت Vite و یکپارچگی Django/React روی کپی آزمایشی اجرا شده‌اند. حسگر React Doctor نیز با نسخهٔ دقیق، دامنهٔ منبع محدود و خروجی قطعی به بازرس فرانت‌اند متصل است.

لوپ webapp-quality-observer همچنان در وضعیت پیش‌نویس باقی می‌ماند، زیرا مالک و تأییدکنندهٔ انسانی هنوز از مقادیر نمونه جایگزین نشده‌اند و هیچ عملگر اصلاح خودکار یا زمان‌بندی فعال نشده است.

آزمون هسته بدون نصب وابستگی خارجی:

python -m unittest discover -s tests -t . -v

پس از ساخت محیط مجازی و نصب وابستگی‌ها، پروفایل محصول را اعتبارسنجی و با موتور اصلی اجرا کنید:

python scripts/run_inspection.py validate config/inspection.local.yaml
python scripts/run_inspection.py run config/inspection.local.yaml --runtime langgraph

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

loop_engineering-0.2.0.tar.gz (36.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

loop_engineering-0.2.0-py3-none-any.whl (33.9 kB view details)

Uploaded Python 3

File details

Details for the file loop_engineering-0.2.0.tar.gz.

File metadata

  • Download URL: loop_engineering-0.2.0.tar.gz
  • Upload date:
  • Size: 36.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for loop_engineering-0.2.0.tar.gz
Algorithm Hash digest
SHA256 48b6f25088691dd3010f44b53a12d1aa357a1f1b174bf14ea95d52f92862b9fe
MD5 dc539582c0a71f73fe50bba977ae7957
BLAKE2b-256 f9939551854bf87b8d1d11694dc1375f3b606c407f85b38d4a4952bdc32ad56c

See more details on using hashes here.

Provenance

The following attestation bundles were made for loop_engineering-0.2.0.tar.gz:

Publisher: publish-pypi.yml on hooman61/loop-engineering

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file loop_engineering-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for loop_engineering-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 030919cfed756abc7006e740fe1351dff044394b3966ddcffab6e061aa9de33d
MD5 3769d1c9268275a9ca5e1cd3c4f6a145
BLAKE2b-256 64fe5580b9f790cea36dcb26ab68a4db6e49ddac9747753b00423908cc8a088d

See more details on using hashes here.

Provenance

The following attestation bundles were made for loop_engineering-0.2.0-py3-none-any.whl:

Publisher: publish-pypi.yml on hooman61/loop-engineering

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page