README.ar.md

مراقبة التهديد

الرصد التهديدي

سي آي/سي دي
طَرد
ميتا

---

تطبيق ويب لإنشاء لوحات معلومات لـثريجيل.

• مسرد
• مراجع
• التوثيق
• القياس عن بعد
• الأدوات

ملخص تنفيذي

الحصول على التعليمات البرمجية الخاصة بك وتشغيلها على النظام الخاص بك.

ملحوظة: الpyproject.tomlيجب أن يكون الملف في جذر المستودع!

ملحوظة: تأكد من الوفاءمتطلبات.

1. عملية التثبيت:

   $ cd threagile-monitoring # start at sub-directory of the repository where the requirements.txt file is kept.
   $ hatch --version # optional, will print the version of our package to the terminal without modifying the source directory (e.g. `0.0.1`).
   # Without hatch: $ python src/threagile_monitoring/app.py
   $ hatch env create # optional, if the default env already exists you will be told
   $ hatch shell # spawn a shell within an environment
   (.hatch) $ cd .. # go one directory up to where pyproject.toml resides
   (.hatch) $ pip install -e . # install the package in editable mode
   (.hatch) $ cd threagile-monitoring # go back to the sub-directory of the repository where the requirements.txt file is kept.
   (.hatch) $ pip show threagile-monitoring # optional, shows the project details, here 'threagile-monitoring', from `pyproject.toml`
   # Name: threagile-monitoring
   # Version: 0.0.1 # it takes this from src/threagile_monitoring/__about__.py
   # ...
   (.hatch) $ python -c "import sys;print(sys.executable)" # optional, see where your environment's python is located
   (.hatch) $ pip install --upgrade pip # optional, the `run` command allows you to execute commands in an environment as if you had already entered it.
   (.hatch) $ pip install -r requirements.txt # pipx won't do this
   (.hatch) $ git tag # check if you already have a verion tagged
   (.hatch) $ git tag -a v0.0.1 -m "Initial release" # optional, if you have no tags yet
   # setuptools_scm displays the version of our package and perform any side-effects like writing to a file. (here: `__about__.py`)

   **حزم موقعك باستخدام حزمة الويب:**بمجرد أن يكون لديك موقع ويب جيد بما يكفي لاستخدامه، يجب عليك حزم التطبيق مع حزمة الويب. تم إدراج مجلد الحزمة هذا في.gitignoreلتجنب ذلك يجب الالتزام بـ git.

   يجب أن تكون جميع الإعدادات جاهزة الآن، لذا كل ما عليك فعله: 1)(.hatch) $ cd src/threagile_monitoring2)(.hatch) $ npm install3)(.hatch) $ npm run build

   سيؤدي هذا إلى إنشاءapp.jsالملف - الذي يحتوي على جميع المكونات - في/src/threagile_monitoring/static/js/.

   التطوير باستخدام حزمة الويب:إذا كنت لا تزال تقوم بتطوير موقع الويب الخاص بك، فيجلسة طرفية منفصلة، بعد اتباع عملية التثبيت المذكورة أعلاه، قم بما يلي: 1)cd ../# انتقل إلى جذر المستودع 2)hatch shell3)(.hatch) $ cd threagile-monitoring/src/threagile_monitoring4)(.hatch) $ sudo chown -R $USER:$(id -gn $USER) ~/.npm5)(.hatch) $ npm install6)(.hatch) $ npm run watch

   سيؤدي هذا - في الجلسة الطرفية المنفصلة (أيbackground) - قم بتحميل التغييرات التي تجريها باستمرار على الملفات المناسبة، بينما يمكنك الاستمرار في إجراء هذه التغييرات - في الجلسة الطرفية الأولية (أي:foreground). لذلك لا يتوجب عليك بناء مصادرك بعد كل تعديل، بل يتم الاهتمام بها تلقائيًا!

   لرؤية التغييرات، ما عليك سوى حفظ متصفحك وإعادة تحميله (عادةً باستخدام F5).

   تأكد من تشغيل صفحة الويب الخاصة بك عند الاختبار باستخدام وظائف الواجهة الخلفية، كما يلي: 1)cd ../# انتقل إلى جذر المستودع 2)hatch shell3)(.hatch) $ cd threagile-monitoring/src/threagile_monitoring4)(.hatch) $ python app.py

   امتحان

   اختبر التطبيق (الواجهة الأمامية) بهذه الطريقة: 1)cd ../# انتقل إلى جذر المستودع 2)hatch shell3)(.hatch) $ cd threagile-monitoring/src/threagile_monitoring4)(.hatch) $ npm install5)(.hatch) $ npm test6)(.hatch) $ npm test -- --coverage

   يجري:

   إذا لم يكن قيد التطوير، قم بتشغيل التطبيق (الواجهة الخلفية والواجهة الأمامية في وقت واحد) بهذه الطريقة:

   $ hatch run python src/threagile_monitoring/app.py # starts the app 
   

2. تبعيات البرمجيات

3. أحدث الإصدارات

4. مراجع واجهة برمجة التطبيقات

5. البناء والاختبار:

   لبناء الكود الخاص بك، استخدم:

   $ cd threagile-monitoring
   $ hatch build

   لاستخدام الذكاء الاصطناعي لمراجعات طلبات السحب، استخدم:

   https://app.coderabbit.ai/dashboard(الاستخداماتphpstan.neon)

   لتشغيل التطبيق استخدم:

   لينكس:

   $ export SECRET_KEY="secret"

   ويندوز:

   $ setx SECRET_KEY secret

   ثم:

   $ cd threagile-monitoring
   # Without hatch: $ python src/threagile_monitoring/app.py
   $ hatch run python src/threagile_monitoring/app.py

   ثم انتقل إلىhttp://127.0.0.1:5000/في متصفح الويب الخاص بك.

   لتشغيل الاختبارات استخدم:

   $ cd threagile-monitoring
   $ pip install pytest # optional
   $ pytest tests/

وثائق واجهة برمجة التطبيقات

انتقل إلىhttp://127.0.0.1:5000/docsفي متصفح الويب الخاص بك، أو قم بتنزيل openapi.json منhttp://127.0.0.1:5000/openapi.json.

المقاييس

دع أداة مثل بروميثيوس تتخلصhttp://127.0.0.1:9464/metrics.

جديد

جدول المحتويات

• تثبيت
• مصدر النسخة
• البيئات
• يبني
• رخصة

تثبيت

pip install threagile-monitoring

مصدر النسخة

• الHatch-vcsيحدد البرنامج المساعد لمصدر الإصدار إصدار المشروع باستخدام علامات Git

البيئات

• تم تعريفها بدقة في قائمة بذاتهاhatch.toml
• الtestتستخدم المصفوفةحاويات الفتحةمكون إضافي لتشغيل كل بيئة داخل حاويات Docker؛ يمكن رؤية الاستخدام فيامتحانسير عمل جيثب

يبني

• تستخدم جميع أهداف البناءHatch-vcsبناء البرنامج المساعد هوك لشحن أ_version.pyملف بحيث يمكن استخدام الإصدار في وقت التشغيل
• تستخدم العجلاتHatch-mypycأنشئ ملحقًا ربطًا لتجميع جميع التعليمات البرمجية أولاًMypyc
• اليبنييوضح سير عمل GitHub كيفية:
  • يستخدمcibuildwheelلتوزيع العجلات الثنائية لكل منصة
  • استخدمبرنامجبناء الهدف لبناء توزيعات مستقلة لكل منصة

رخصة

threagile-monitoringيتم توزيعها بموجب شروطمعرخصة.

100- مقدمة

يرىREADME.md

200 - المتطلبات

يرىREADME.md

300 – بناء تطبيقنا

يرىREADME.md

400 - الخاتمة

يرىREADME.md