প্রকল্প সম্পর্কে

finra-py হলো একটি অনানুষ্ঠানিক, ওপেন-সোর্স Python ক্লায়েন্ট লাইব্রেরি যা FINRA API প্ল্যাটফর্মকে র‍্যাপ (wrap) করে। এটি একটি ইচ্ছাকৃতভাবে পাতলা লেয়ার হিসেবে কাজ করে: রিকোয়েস্টগুলো FINRA API-তে ম্যাপ করা হয় এবং raw httpx.Response অবজেক্টগুলো কলারের কাছে ফেরত পাঠানো হয়, যাতে কোনো নিজস্ব রেসপন্স বা ডেটা মডেল চাপিয়ে দেওয়া না হয়। এর লক্ষ্য হলো সরাসরি HTTP রিকোয়েস্টের নিয়ন্ত্রণ না হারিয়ে একটি ডেডিকেটেড FINRA ক্লায়েন্টের সুবিধা প্রদান করা। অথেন্টিকেশন হলো প্রধান বিষয় যা এই লাইব্রেরিটি ব্যবহারকারীর দায়িত্ব থেকে কমিয়ে দেয়। 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 ওয়ার্কফ্লো, যা 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` হিসেবে ইমপোর্ট করা হয়। সম্পূর্ণ ডকুমেন্টেশন আলাদাভাবে হোস্ট করা হয়েছে, যেখানে README থেকে Getting Started গাইড, ADR নোট এবং চেঞ্জলগ লিঙ্ক করা আছে। সীমাবদ্ধতাগুলো স্পষ্টভাবে উল্লেখ করা হয়েছে: যদিও লাইব্রেরিটি নথিভুক্ত সমস্ত ডেটাসেটের পূর্ণ কভারেজের লক্ষ্য রাখে, তবে কিছু FINRA ডেটাসেট এবং পরিষেবা হয়তো API-এর মাধ্যমে একেবারেই উন্মুক্ত নয়, এবং fileX API বর্তমানে স্পষ্টভাবে সমর্থিত নয়। ডেভলপমেন্ট GitHub ইস্যু-এর মাধ্যমে পরিচালিত হয়, যেখানে বাগ রিপোর্ট এবং ফিচার রিকোয়েস্ট স্বাগত জানানো হয়, তবে বর্তমানে পুল রিকোয়েস্ট গ্রহণ করা হচ্ছে না। লেখক FINRA API ইন্টিগ্রেশন, Web EFT মাইগ্রেশন, কমপ্লায়েন্স-সম্পর্কিত ওয়ার্কফ্লো এবং মার্কেট ডেটা সিস্টেমের জন্য কনসাল্টিং পরিষেবাও প্রদান করেন। প্রজেক্টটিতে CI এবং কভারেজ ব্যাজ রয়েছে এবং এটি Windows, macOS এবং Linux-এ টেস্ট কভারেজ বর্ণনা করে। README-তে একটি ডিসক্লেমার রয়েছে যে এই লাইব্রেরিটি অনানুষ্ঠানিক এবং FINRA দ্বারা অনুমোদিত, অনুমোদিত বা স্পনসর করা নয়; এটি কোনো আর্থিক পরামর্শ বা ট্রেডিং কৌশল প্রদান করে না এবং ব্যবহারকারীরা মূল API-এর পরিষেবার শর্তাবলী মেনে চলার জন্য দায়ী। এটি কোনো ওয়ারেন্টি ছাড়াই একটি LICENSE ফাইলের অধীনে বিতরণ করা হয়। ডিরেক্টরির উদ্দেশ্যে এটি developer-tools-এর অধীনে একটি ব্যাকএন্ড/API ক্লায়েন্ট লাইব্রেরি হিসেবে রাখা সবচেয়ে ভালো, এবং data-integration একটি গৌণ ফিট হিসেবে গণ্য হবে যেহেতু এর ব্যবহারিক কাজ হলো রেগুলেটরি এবং মার্কেট ডেটাসেট অন্যান্য সিস্টেমে নিয়ে আসা।