عن المشروع
finra-py هي مكتبة عميل Python غير رسمية ومفتوحة المصدر تغلف منصة واجهة برمجة تطبيقات FINRA. تقدم نفسها كطبقة رقيقة عمدًا: يتم تعيين الطلبات onto واجهة برمجة تطبيقات FINRA وتُعاد كائنات httpx.Response الخام إلى المتصل، لذا لا يتم فرض نموذج استجابة أو بيانات خاص. الهدف المذكور هو تقديم راحة عميل FINRA مخصص دون التخلي عن التحكم في طلبات HTTP المباشرة.
المصادقة هي الأمر الرئيسي الذي تتعامل معه المكتبة نيابةً عن المستخدم. تستخدم واجهة برمجة تطبيقات FINRA OAuth 2.0، وتدير finra-py اكتساب الرمز وإدارته، بما في ذلك تخزين الرمز القابل للتخصيص للتطبيقات التي تحتفظ ببيانات الاعتماد في أنظمتها الخاصة.
تذكر قائمة README تغطية ثلاث مناطق لواجهة برمجة التطبيقات:
- مجموعات بيانات واجهة برمجة تطبيقات Query، بما في ذلك الأسهم، الدخل الثابت، FINRA، الشركة، التسجيل وبطاقة تقرير TRACE.
- مجموعات بيانات واجهة برمجة تطبيقات الإخطار لأحداث الإخطار الخاصة بـ FINRA.
- سير عمل واجهة برمجة تطبيقات الإرسال للتسجيلات التنظيمية والبيانات الأخرى، يغطي الإنشاء، التحقق، الإرسال، التحديثات والاسترداد لنموذج U4، نموذج U5، نموذج BR، إنشاء فرد، بصمة غير مسجلة والتدفقات المدعومة الأخرى.
تشمل القدرات الموثقة الإضافية دعم جميع أنواع بيانات الاعتماد، ومجموعات بيانات وهمية، وواجهة برمجة تطبيقات بيئة اختبار QA، والطلبات غير المتزامنة من جانب الخادم، وasyncio من جانب العميل.
يتطلب التثبيت Python 3.11 أو أحدث ويتم عبر الأمر `python -m pip install finra-py`؛ يتم استيراد الحزمة كـ `import finra`. يتم استضافة الوثائق الكاملة بشكل منفصل، مع دليل البدء السريع، ملاحظات ADR وسجل التغييرات المرتبطة من README.
تُذكر القيود بوضوح: على الرغم من أن المكتبة تهدف إلى تغطية كاملة لمجموعات البيانات الموثقة، قد لا يتم كشف بعض مجموعات بيانات وخدمات FINRA عبر واجهة برمجة التطبيقات على الإطلاق، وواجهة برمجة تطبيقات fileX غير مدعومة صراحةً في الوقت الحالي.
يتم التعامل مع التطوير من خلال قضايا GitHub، حيث تُرحب تقارير الأخطاء وطلبات الميزات، على الرغم من عدم قبول طلبات السحب حاليًا. كما يعلن المؤلف عن خدمات استشارية حول تكامل واجهة برمجة تطبيقات FINRA، وهجرات ويب EFT، وسير عمل متعلق بالامتثال وأنظمة بيانات السوق. يشتمل المشروع على شارات CI وتغطية ويصف تغطية الاختبار عبر Windows وmacOS وLinux.
تحتوي README على إخلاء مسؤولية بأن المكتبة غير رسمية ولا يتم تأييدها أو انتماؤها أو رعايتها من قبل FINRA، وأنها لا تقدم نصائح مالية أو استراتيجيات تداول، وأن المستخدمين مسؤولون عن الالتزام بشروط خدمة واجهة برمجة التطبيقات الأساسية. يتم توزيعها تحت ملف LICENSE دون ضمان.
لأغراض الفهرسة، يُفضل وضعها تحت developer-tools كمكتبة عميل خلفية/واجهة برمجة تطبيقات، مع data-integration كملاءمة ثانوية نظرًا لاستخدامها العملي في سحب مجموعات البيانات التنظيمية والسوقية إلى أنظمة أخرى.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.