Skip to content

Latest commit

 

History

History
176 lines (112 loc) · 7.62 KB

README.ar.md

File metadata and controls

176 lines (112 loc) · 7.62 KB
Raw

مللي-فريق-شريط التذاكر

شريط شريط MS Teams

سلوجلاين

ملخص تنفيذي

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

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

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

    $ cd ticker-tape
$ 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/ticker_tape/app.py
$ hatch env create # optional, if the default env already exists you will be told
$ hatch shell # spawn a shell within an environment
(ticker-tape) $ pip show ticker-tape # optional, shows the project details, here 'ticker-tape', from `pyproject.toml`
# Name: ticker-tape
# Version: 0.0.1 # it takes this from src/ticker_tape/__about__.py
# ...
(ticker-tape) $ python -c "import sys;print(sys.executable)" # optional, see where your environment's python is located
(ticker-tape) $ pip install --upgrade pip # optional, the `run` command allows you to execute commands in an environment as if you had already entered it.
(ticker-tape) $ pip install -r requirements.txt # pipx won't do this
(ticker-tape) $ python -m setuptools_scm # optional, display the version of our package and perform any side-effects like writing to a file. (here: `_version.py`)
(ticker-tape) $ exit # optional, type `exit` to leave the environment

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

    يجب أن تكون جميع الإعدادات جاهزة الآن، لذا كل ما عليك فعله: 1)$ hatch shell2)(ticker-tape) $ cd src/ticker_tape3)(ticker-tape) $ npm install4)(ticker-tape) $ npm run build

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

    التطوير باستخدام حزمة الويب:إذا كنت لا تزال تقوم بتطوير موقع الويب الخاص بك، فيجلسة طرفية منفصلة، بعد اتباع عملية التثبيت المذكورة أعلاه، قم بما يلي: 1)$ hatch shell2)(ticker-tape) $ cd src/ticker_tape3)(ticker-tape) $ npm install4)(ticker-tape) $ npm run watch

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

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

    تأكد من تشغيل صفحة الويب الخاصة بك عند الاختبار باستخدام وظائف الواجهة الخلفية، كما يلي: 1)(ticker-tape) $ cd src/ticker_tape2)(ticker-tape) $ python app.py

    امتحان

    اختبر التطبيق (الواجهة الأمامية) بهذه الطريقة:

    1)$ hatch shell2)(ticker-tape) $ cd src/ticker_tape3)(ticker-tape) $ npm install4)(ticker-tape) $ npm test5)(ticker-tape) $ npm test -- --coverage

    يجري:

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

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

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

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

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

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

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

    $ cd ticker-tape
$ hatch build

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

    https://app.coderabbit.ai/dashboard

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

    لينكس:

    $ export SECRET_KEY="secret"

    ويندوز:

    $ setx SECRET_KEY secret

    ثم:

    $ cd ticker-tape
# Without hatch: $ python src/ticker_tape/app.py
$ hatch run python src/ticker_tape/app.py

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

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

    $ cd ticker-tape
$ 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 ticker-tape

مصدر النسخة

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

البيئات

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

يبني

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

رخصة

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

100- مقدمة

يرىREADME.md

200 - المتطلبات

يرىREADME.md

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

يرىREADME.md

400 - الخاتمة

يرىREADME.md