منصوبے کے بارے میں
finra-py غیر רשمی، اوپن سورس Python کلائنٹ لائبریری ہے جو FINRA API Platform کو لپیٹتی ہے۔ یہ خود کو عمدہ باتلی layer کے طور پر پیش کرتی ہے: درخواستیں FINRA API پر map ہوتی ہیں اور خام httpx.Response اشیاء کال کرنے والے کو واپس دی جاتی ہیں، اس لیے کوئی مخصوص response یا ڈیٹا_MODEL thrust نہیں کیا جاتا۔ منظور شدہ مقصد ایک مخصوص FINRA کلائنٹ کیfacility فراہم کرنا ہے جبکہ straight HTTP requestوں کا کنٹرول بھی محفوظ رکھا جائے۔
Authentication library کا اصلی کام ہے جو یہ użytper کے ہاتھ سے لے لیتی ہے۔ FINRA API OAuth 2.0 استعمال کرتا ہے، اور finra-py ٹوکن حاصل کرنے اور زندگی چکر کا انتظام کرتی ہے، جس میں ان ایپلیکیشنز کے لیے قابل تنظیم ٹوکن سٹوریج شامل ہے جو apne apne نظام میں credentials محفوظ رکھتے ہیں۔
README تین API کے علاقوں کی covering فہرست بناتی ہے:
- Query API ڈیٹاسets، جن میں Equity, Fixed Income, FINRA, Firm, Registration اور TRACE Report Card شامل ہیں۔
- Notification API ڈیٹاسets، FINRA notification واقعات کے لیے۔
- Submission API ورکفلوز، नियामک filing اور دیگر ڈیٹا کے لیے، جن میں Form U4, Form U5, Form BR, Create Individual, Non-Registered Fingerprint اور دیگر سپورٹڈ flows کی بنائید، تصدیق، submission، اپ ڈیٹ اور retrieval شامل ہے۔
مزید دستاویز کردہ صلاحیتوں میں تمام credential types کا سپورٹ، Mock ڈیٹاسets، QA Test Environment API، سرور جانب asynchronous requests، اور کلائنٹ جانب asyncio شامل ہیں۔
Insallation کے لیے Python 3.11 یا اس سے اوپر ضروری ہے اور یہ `python -m pip install finra-py` 명령을 چلाकर کی جاتی ہے؛ پکیج کو `import finra` کے طور پر imported کیا جاتا ہے۔ مکمل دستاویز الگ سے hoست کی جاتی ہے، جس میں Getting Started گائیڈ، ADR notes اور changelog شامل ہیں جنہیں README سے link کیا گیا ہے۔
حدود واضح طور پر بتائی جاتی ہیں: اگرچہ لائبریری کا هدف دستاویز کردہ ڈیٹاسets کی پوری coverage حاصل کرنا ہے، لیکن کچھ FINRA ڈیٹاسets اور خدمات API کے ذریعے vůобще exposed نہیں ہو سکتیں، اور fileX API اس وقت واضح طور پر सपورٹ نہیں کیا جاتا۔
تطوير GitHub issues کے ذریعے χειریا جاتا ہے، جہاں bug reports اور feature requests خوش آمدید ہیں، اگرچہ pull requests ابھی قبول نہیں کیے جاتے۔ مصنف FINRA API integrations، Web EFT migrations، compliance-related workflows اور market data systems کے ارد گرد consulting services کا بھی اعلان کرتا ہے۔ پروجيٹ CI اور coverage badges کے ساتھ ship ہوتا ہے اور Windows, macOS اور Linux پر test coverage کی وضاحت کرتا ہے۔
README میں ایک disclaimer شامل ہے کہ لائبریری غیر רשمی ہے اور FINRA کی طرف سے endorsered، affiliated یا sponsored نہیں ہے، یہ کوئی مالی نصیحت یا trading strategy فراہم نہیں کرتی، اور استعمال کرنے والے underlying API کی terms of service کی پابندی کے لیے ذمہ دار ہیں۔ یہ یک LICENSE file کے تحت warranty کے बिना distribute کی جاتی ہے۔
دليل کے منظور سے، یہ developer-tools کے تحت backend/API client library کے طور پر رکھنا بہتر ہے، اور data-integration ایک втори fit ہے کیونکہ اس کا عملی استعمال regulatory اور market datasets کو دیگر systèmes میں لانا ہے۔
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.