इस प्रोजेक्ट के बारे में

finra-py एक अनौपचारिक, ओपन-सोर्स Python क्लाइंट लाइब्रेरी है जो FINRA API Platform को wrap करती है। यह जानबूझकर एक पतली परत के रूप में कार्य करती है: FINRA API पर अनुरोध मैप किए जाते हैं और raw httpx.Response objects caller को सौंप दिए जाते हैं, इसलिए कोई स्वामित्व वाला response या डेटा मॉडल थोपा नहीं जाता। इसका उद्देश्य समर्पित FINRA क्लाइंट की सुविधा प्रदान करना है बिना सीधे HTTP अनुरोधों पर नियंत्रण खोए। प्रमाणीकरण वह मुख्य कार्य है जिसे यह लाइब्रेरी उपयोगकर्ता के लिए संभालती है। FINRA API OAuth 2.0 का उपयोग करता है, और finra-py टोकन प्राप्त और जीवनचक्र का प्रबंधन करती है, जिसमें उन एप्लिकेशन के लिए अनुकूलनीय टोकन संग्रह भी शामिल है जो अपने सिस्टम में क्रेडेंशियल्स रखते हैं। README के अनुसार तीन API क्षेत्रों की कवर करने: - Query API डेटासेट्स, जिनमें Equity, Fixed Income, FINRA, Firm, Registration और TRACE Report Card शामिल हैं। - FINRA अधिसूचना घटनाओं के लिए Notification API डेटासेट्स। - नियामकीय फाइलिंग और अन्य डेटा के लिए Submission API workflows, जिसमें Form U4, Form U5, Form BR, Create Individual, Non-Registered Fingerprint और अन्य समर्थित प्रवाह के लिए निर्माण, सत्यापन, सबमिशन, अपडेट और पुनर्प्राप्ति शामिल है। अतिरिक्त दस्तावेज़ीकृत क्षमताओं में सभी क्रेडेंशियल प्रकारों का समर्थन, Mock डेटासेट्स, QA Test Environment API, सर्वर-साइड पर असिंक्रोनस अनुरोध और क्लाइंट-साइड पर asyncio शामिल हैं। स्थापना के लिए Python 3.11 या बाद वाला आवश्यक है और `python -m pip install finra-py` से की जाती है; पैकेज को `import finra` के रूप में इम्पोर्ट किया जाता है। पूर्ण दस्तावेज़ अलग से होस्ट किया गया है, जिसमें Getting Started गाइड, ADR नोट्स और changelog README से लिंक हैं। सीमाओं को स्पष्ट रूप से बताया गया है: हालांकि लाइब्रेरी दस्तावेज़ीकृत डेटासेट्स की पूर्ण कवर करने का लक्ष्य रखती है, कुछ FINRA डेटासेट और सेवाएँ API के माध्यम से बिल्कुल उपलब्ध नहीं हैं, और fileX API वर्तमान में स्पष्ट रूप से समर्थित नहीं है। विकास GitHub issues के माध्यम से किया जाता है, जहाँ बग रिपोर्ट और फीचर अनुरोध स्वागत योग्य हैं, हालांकि pull requests अभी स्वीकार नहीं किए जा रहे हैं। लेखक FINRA API इंटीग्रेशन, Web EFT मাইग्रेशन, अनुपालन-संबंधी workflows और मार्केट डेटा सिस्टम के आसपास परामर्श सेवाओं का भी विज्ञापन करते हैं। प्रोजेक्ट CI और कवरेज बैज के साथ आता है और Windows, macOS तथा Linux पर टेस्ट कवरेज का वर्णन करता है। README में एक अस्वीकरण है कि यह लाइब्रेरी अनौपचारिक है और FINRA द्वारा अनुमोदित, संबद्ध या प्रायोजित नहीं है, कि यह कोई वित्तीय सलाह या ट्रेडिंग रणनीतियाँ प्रदान नहीं करती है, और उपयोगकर्ता बुनियादी API के सेवा शर्तों के अनुपालन के लिए उत्तरदायी हैं। इसे बिना किसी वारंटी के एक LICENSE फ़ाइल के तहत वितरित किया गया है। डायरेक्ट्री उद्देश्यों के लिए, इसे backend/API क्लाइंट लाइब्रेरी के रूप में developer-tools के अधीन रखना सबसे उपयुक्त है, जबकि data-integration एक द्वितीयक विकल्प है क्योंकि इसका व्यावहारिक उपयोग नियामकीय और मार्केट डेटासेट्स को अन्य सिस्टम में खींचने से संबंधित है।