fima 0.1.0__tar.gz

fima-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Your Name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fima-0.1.0/PKG-INFO

@@ -0,0 +1,270 @@
+Metadata-Version: 2.4
+Name: fima
+Version: 0.1.0
+Summary: fima – A Python package for scraping and analyzing Iran’s financial market data. It currently supports bonds and options, with tools for calculating BSM prices, greeks, and implied volatility. Future versions will expand to include other instruments such as commodities and more.
+Home-page: https://github.com/hemoboghosian/fima
+Author: Hemo Boghosian
+Author-email: Hemo Boghosian <HemoBoghosian@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/hemoboghosian/fima
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas
+Requires-Dist: requests
+Requires-Dist: jdatetime
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: bs4
+Requires-Dist: selenium
+Requires-Dist: mibian
+Requires-Dist: lxml
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# fima
+## معرفی و هدف
+
+
+این کتابخانه جهت دسترسی آسان و سریع به داده‌های بازارهای مالی ایران با زبان برنامه‌نویسی پایتون پیاده‌سازی شده است. هدف نهایی این پروژه، ساخت کتابخانه‌ای جامع جهت استخراج، ساختاردهی و تحلیل داده‌های مالی از منابع مختلف موجود است.
+**این کتابخانه هنوز در حال توسعه و تکامل است و ممکن است در برخی قسمت‌ها اشتباهاتی داشته باشد. لطفاً اگر خطا یا نقصی دیدید اطلاع دهید.**
+
+## اطلاعات تماس
+* ایمیل: HemoBoghosian@gmail.com
+* تلگرام: @HemoBoghosian
+
+## نصب کتابخانه
+```
+pip install fima
+```
+
+## توابع مربوط به اختیارهای معامله
+### فراخوانی تمام توابع
+
+```python
+from fima.Options import *
+```
+
+### دریافت سابقه قیمت اختیار معامله و دارایی پایه آن
+
+```python
+from fima.Options import download_historical_data
+
+option_historical_data, ua_historical_data = download_historical_data(ticker='ضهرم4018', start_date='1404-01-01',
+                                                                      end_date='1404-01-31')
+```
+#### ورودی
+* ticker: نماد اختیار معامله
+* start_date: تاریخ شروع داده‌ها
+* end_date: تاریخ پایان داده‌ها
+
+#### خروجی
+* option_historical_data: سابقه قیمت اختیار معامله
+* ua_historical_data: سابقه قیمت دارایی پایه نماد وارد شده
+
+##### توجه: در صورت وارد نکردن تاریخ شروع و پایان، خروجی تابع تمام سابقه قیمت اختیار معامله و دارایی پایه آن خواهد بود.
+
+### دریافت اطلاعات لحظه‌ای یک نماد اختیار معامله
+
+```python
+from fima.Options import ticker_info
+
+ticker_info_data = ticker_info(ticker='ضهرم4018', j_date=True)
+```
+
+#### ورود
+* ticker: نماد اختیار معامله مد نظرم
+* j_date: تاریخ شمسی
+
+#### خروجی
+* ticker_info_data: اطلاعات لحظه‌ای مربوط به نماد مد نظر
+
+### دریافت زنجیره قراردادهای یک دارایی پایه
+
+```python
+from fima.Options import download_chain_contracts
+
+chain_contracts = download_chain_contracts(underlying_ticker='اهرم', j_date=True, bsm=False, greeks=False,
+                                           implied_volatility=False)
+```
+#### ورودی
+* underlying_ticker: نماد دارایی پایه
+* j_date: تاریخ شمسی
+* bsm: محاسبه ارزش اختیار معامله با مدل بلک، شولز و مرتون 
+* greeks: محاسبه دلتا، تتا، گاما، رو و وگا
+* implied_volatility: محاسبه نوسانات ضمنی
+
+#### خروجی
+* chain_contracts: اطلاعات تمامی زنجیره قراردادهای مربوط به دارایی پایه مد نظر
+
+##### توجه: برای محاسبات مربوط به مدل بلک، شولز و مرتون از میانگین نرخ بازده تا سررسید اسناد خزانه در آخرین تاریخ (دریافت‌شده از سایت فرابورس ایران) به عنوان نرخ بازده بدون ریسک استفاده می‌شود.
+
+### دریافت دیده‌بان بازار
+
+```python
+from fima.Options import download_market_watch
+
+market_watch = download_market_watch(market='All', stack='Vertical', j_date=True, bsm=False, greeks=False,
+                                     implied_volatility=False)
+```
+#### ورودی
+* market: بازار معامله اختیار معامله
+  * 'TSE': بورس اوراق بهادار تهران
+  * 'IFB': فرابورس ایران
+  * 'All': تمامی اختیارهای معامله
+* stack: نحوه چینش داده‌ها
+  * 'Vertical': چینش عمودی داده‌ها
+  * 'Horizontal': چینش افقی داده‌ها
+* j_date: تاریخ شمسی
+* bsm: محاسبه ارزش اختیار معامله با مدل بلک، شولز و مرتون 
+* greeks: محاسبه دلتا، تتا، گاما، رو و وگا
+* implied_volatility: محاسبه نوسانات ضمنی
+
+#### خروجی
+* market_watch: اطلاعات تمامی اختیارهای معامله بازار مد نظر
+
+##### توجه: برای محاسبات مربوط به مدل بلک، شولز و مرتون از میانگین نرخ بازده تا سررسید اسناد خزانه در آخرین تاریخ (دریافت‌شده از سایت فرابورس ایران) به عنوان نرخ بازده بدون ریسک استفاده می‌شود.
+
+### دریافت ارزش محاسبه‌شده توسط مدل بلک، شولز و مرتون برای یک نماد
+
+```python
+from fima.Options import black_scholes_merton
+
+volatility, bsm_price = black_scholes_merton(ticker='ضهرم4018')
+```
+#### ورودی
+* ticker: نماد اختیار معامله مد نظر
+
+#### خروجی
+* volatility: نوسانات دارایی پایه محاسبه‌شده در مدل
+* bsm_price: ارزش محاسبه‌شده اختیار معامله مد نظر با مدل بلک، شولز و مرتون
+
+##### توجه
+* توجه: در صورت عدم وارد کردن متغیر مربوط به نرخ بازده بدون ریسک، برای محاسبات مربوط به مدل بلک، شولز و مرتون از میانگین نرخ بازده تا سررسید اسناد خزانه در آخرین تاریخ (دریافت‌شده از سایت فرابورس ایران) به عنوان نرخ بازده بدون ریسک استفاده می‌شود.
+* در صورتی که روزهای باقی‌مانده تا سررسید اختیار معامله کمتر از ۱۰ روز باشند، به دلیل احتمال خطا، مدل بلک، شولز و مرتون اعمال نخواهد شد.
+
+### دریافت گریکز برای یک نماد
+
+```python
+from fima.Options import get_greeks
+
+ticker_greeks = get_greeks(ticker='ضهرم4018')
+```
+#### ورودی
+* ticker: نماد اختیار معامله مد نظر
+* r_f: نرخ بازده بدون ریسک
+* minimum_required_history: کمینه دیتای مورد نیاز برای دارایی پایهجهت محاسبه نوسانات که به صورت پیش‌فرض ۳۰ روز در نظر گرفته شده است.
+
+#### خروجی
+* ticker_greeks: دلتا، تتا، گاما، وگا و رو برای نماد مد نظر 
+
+##### توجه 
+* در صورت عدم وارد کردن متغیر مربوط به نرخ بازده بدون ریسک، برای محاسبات مربوط به مدل بلک، شولز و مرتون از میانگین نرخ بازده تا سررسید اسناد خزانه در آخرین تاریخ (دریافت‌شده از سایت فرابورس ایران) به عنوان نرخ بازده بدون ریسک استفاده می‌شود.
+* در صورتی که روزهای باقی‌مانده تا سررسید اختیار معامله کمتر از ۱۰ روز باشند، به دلیل احتمال خطا، مدل بلک، شولز و مرتون اعمال نخواهد شد.
+
+### دریافت نوسانات ضمنی برای یک نماد
+
+```python
+from fima.Options import get_implied_volatility
+
+ticker_implied_volatility = get_implied_volatility(ticker='ضهرم4018')
+```
+#### ورودی
+* ticker: نماد اختیار معامله مد نظر
+* r_f: نرخ بازده بدون ریسک
+* minimum_required_history: کمینه دیتای مورد نیاز برای دارایی پایهجهت محاسبه نوسانات که به صورت پیش‌فرض ۳۰ روز در نظر گرفته شده است.
+
+#### خروجی
+* ticker_implied_volatility: نوسانات ضمنی برای نماد مد نظر 
+
+##### توجه 
+* در صورت عدم وارد کردن متغیر مربوط به نرخ بازده بدون ریسک، برای محاسبات مربوط به مدل بلک، شولز و مرتون از میانگین نرخ بازده تا سررسید اسناد خزانه در آخرین تاریخ (دریافت‌شده از سایت فرابورس ایران) به عنوان نرخ بازده بدون ریسک استفاده می‌شود.
+* در صورتی که روزهای باقی‌مانده تا سررسید اختیار معامله کمتر از ۱۰ روز باشند، به دلیل احتمال خطا، مدل بلک، شولز و مرتون اعمال نخواهد شد.
+
+### دریافت تمامی نمادهای دارای اختیار معامله
+
+```python
+from fima.Options import download_all_underlying_assets
+
+all_underlying_assets = download_all_underlying_assets(market='All')
+```
+#### ورودی
+* market: بازار معامله اختیار معامله
+  * 'TSE': بورس اوراق بهادار تهران
+  * 'IFB': فرابورس ایران
+  * 'All': تمامی اختیارهای معامله (حالت پیش‌فرض)
+
+#### خروجی
+* all_underlying_assets: اطلاعات مربوط به نمادهای دارای اختیار معامله
+
+#### توجه: در صورت عدم وارد کردن market، تمامی اختیارهای معامله دریافت خواهد شد. 
+
+### توابع مربوط به محاسبات
+
+```python
+from fima.Options import (calculate_black_scholes_merton, calculate_delta, calculate_vega,
+                          calculate_theta, calculate_gamma, calculate_rho)
+
+bsm_price = calculate_black_scholes_merton(s=550, k=28000, option_type='Call', t=71, sigma=0.9588, r_f=0.3372)
+delta = calculate_delta(s=550, k=28000, option_type='Call', t=71, sigma=0.9588, r_f=0.3372)
+theta = calculate_theta(s=550, k=28000, option_type='Call', t=71, sigma=0.9588, r_f=0.3372)
+gamma = calculate_gamma(s=550, k=28000, t=71, sigma=0.9588, r_f=0.3372)
+rho = calculate_rho(s=550, k=28000, option_type='Call', t=71, sigma=0.9588, r_f=0.3372)
+vega = calculate_vega(s=550, k=28000, t=71, sigma=0.9588, r_f=0.3372)
+```
+
+## توابع مربوط به اوراق درآمد ثابت
+### فراخوانی تمام توابع
+
+```python
+from fima.Bonds import *
+```
+
+### دریافت سابقه قیمت اختیار معامله و دارایی پایه آن
+
+```python
+from fima.Bonds import get_risk_free_rate
+
+risk_free_rate = get_risk_free_rate()
+```
+
+#### خروجی
+* risk_free_rate: میانگین نرخ بازده تا سررسید اسناد خزانه در آخرین تاریخ (دریافت‌شده از سایت فرابورس ایران)
+
+### دریافت اوراق درآمد ثابت بدون کوپن
+
+```python
+from fima.Bonds import get_all_bonds_without_coupons
+
+all_bonds_without_coupons = get_all_bonds_without_coupons(deprecated=True)
+```
+
+#### ورودی
+* deprecated:
+  * True: اوراق سررسید شده نیز در خروجی بیاید
+  * False: اوراق سررسید شده در خروجی نیاید
+#### خروجی
+* all_bonds_without_coupons: اطلاعات مربوط به اوراق درآمد ثابت بدون کوپن (دریاقت‌شده از سایت فرابورس ایران)
+
+### دریافت اوراق درآمد ثابت با کوپن
+
+```python
+from fima.Bonds import get_all_bonds_with_coupons
+
+all_bonds_with_coupons = get_all_bonds_with_coupons(deprecated=True)
+```
+
+#### ورودی
+* deprecated:
+  * True: اوراق سررسید شده نیز در خروجی بیاید
+  * False: اوراق سررسید شده در خروجی نیاید
+#### خروجی
+* all_bonds_without_coupons: اطلاعات مربوط به اوراق درآمد ثابت با کوپن (دریاقت‌شده از سایت فرابورس ایران)
+
+## نقشه راه
+1. [ ] عیب‌یابی و بهبود توابع پیاده‌سازی‌شده
+2. [ ] دریافت اطلاعات از سایت tgju
+3. [ ] دریافت اطلاعات از سایت tsetmc
+4. [ ] دریافت و پاکسازی اطلاعات سایت codal

fima-0.1.0/README.md

@@ -0,0 +1,244 @@
+# fima
+## معرفی و هدف
+
+
+این کتابخانه جهت دسترسی آسان و سریع به داده‌های بازارهای مالی ایران با زبان برنامه‌نویسی پایتون پیاده‌سازی شده است. هدف نهایی این پروژه، ساخت کتابخانه‌ای جامع جهت استخراج، ساختاردهی و تحلیل داده‌های مالی از منابع مختلف موجود است.
+**این کتابخانه هنوز در حال توسعه و تکامل است و ممکن است در برخی قسمت‌ها اشتباهاتی داشته باشد. لطفاً اگر خطا یا نقصی دیدید اطلاع دهید.**
+
+## اطلاعات تماس
+* ایمیل: HemoBoghosian@gmail.com
+* تلگرام: @HemoBoghosian
+
+## نصب کتابخانه
+```
+pip install fima
+```
+
+## توابع مربوط به اختیارهای معامله
+### فراخوانی تمام توابع
+
+```python
+from fima.Options import *
+```
+
+### دریافت سابقه قیمت اختیار معامله و دارایی پایه آن
+
+```python
+from fima.Options import download_historical_data
+
+option_historical_data, ua_historical_data = download_historical_data(ticker='ضهرم4018', start_date='1404-01-01',
+                                                                      end_date='1404-01-31')
+```
+#### ورودی
+* ticker: نماد اختیار معامله
+* start_date: تاریخ شروع داده‌ها
+* end_date: تاریخ پایان داده‌ها
+
+#### خروجی
+* option_historical_data: سابقه قیمت اختیار معامله
+* ua_historical_data: سابقه قیمت دارایی پایه نماد وارد شده
+
+##### توجه: در صورت وارد نکردن تاریخ شروع و پایان، خروجی تابع تمام سابقه قیمت اختیار معامله و دارایی پایه آن خواهد بود.
+
+### دریافت اطلاعات لحظه‌ای یک نماد اختیار معامله
+
+```python
+from fima.Options import ticker_info
+
+ticker_info_data = ticker_info(ticker='ضهرم4018', j_date=True)
+```
+
+#### ورود
+* ticker: نماد اختیار معامله مد نظرم
+* j_date: تاریخ شمسی
+
+#### خروجی
+* ticker_info_data: اطلاعات لحظه‌ای مربوط به نماد مد نظر
+
+### دریافت زنجیره قراردادهای یک دارایی پایه
+
+```python
+from fima.Options import download_chain_contracts
+
+chain_contracts = download_chain_contracts(underlying_ticker='اهرم', j_date=True, bsm=False, greeks=False,
+                                           implied_volatility=False)
+```
+#### ورودی
+* underlying_ticker: نماد دارایی پایه
+* j_date: تاریخ شمسی
+* bsm: محاسبه ارزش اختیار معامله با مدل بلک، شولز و مرتون 
+* greeks: محاسبه دلتا، تتا، گاما، رو و وگا
+* implied_volatility: محاسبه نوسانات ضمنی
+
+#### خروجی
+* chain_contracts: اطلاعات تمامی زنجیره قراردادهای مربوط به دارایی پایه مد نظر
+
+##### توجه: برای محاسبات مربوط به مدل بلک، شولز و مرتون از میانگین نرخ بازده تا سررسید اسناد خزانه در آخرین تاریخ (دریافت‌شده از سایت فرابورس ایران) به عنوان نرخ بازده بدون ریسک استفاده می‌شود.
+
+### دریافت دیده‌بان بازار
+
+```python
+from fima.Options import download_market_watch
+
+market_watch = download_market_watch(market='All', stack='Vertical', j_date=True, bsm=False, greeks=False,
+                                     implied_volatility=False)
+```
+#### ورودی
+* market: بازار معامله اختیار معامله
+  * 'TSE': بورس اوراق بهادار تهران
+  * 'IFB': فرابورس ایران
+  * 'All': تمامی اختیارهای معامله
+* stack: نحوه چینش داده‌ها
+  * 'Vertical': چینش عمودی داده‌ها
+  * 'Horizontal': چینش افقی داده‌ها
+* j_date: تاریخ شمسی
+* bsm: محاسبه ارزش اختیار معامله با مدل بلک، شولز و مرتون 
+* greeks: محاسبه دلتا، تتا، گاما، رو و وگا
+* implied_volatility: محاسبه نوسانات ضمنی
+
+#### خروجی
+* market_watch: اطلاعات تمامی اختیارهای معامله بازار مد نظر
+
+##### توجه: برای محاسبات مربوط به مدل بلک، شولز و مرتون از میانگین نرخ بازده تا سررسید اسناد خزانه در آخرین تاریخ (دریافت‌شده از سایت فرابورس ایران) به عنوان نرخ بازده بدون ریسک استفاده می‌شود.
+
+### دریافت ارزش محاسبه‌شده توسط مدل بلک، شولز و مرتون برای یک نماد
+
+```python
+from fima.Options import black_scholes_merton
+
+volatility, bsm_price = black_scholes_merton(ticker='ضهرم4018')
+```
+#### ورودی
+* ticker: نماد اختیار معامله مد نظر
+
+#### خروجی
+* volatility: نوسانات دارایی پایه محاسبه‌شده در مدل
+* bsm_price: ارزش محاسبه‌شده اختیار معامله مد نظر با مدل بلک، شولز و مرتون
+
+##### توجه
+* توجه: در صورت عدم وارد کردن متغیر مربوط به نرخ بازده بدون ریسک، برای محاسبات مربوط به مدل بلک، شولز و مرتون از میانگین نرخ بازده تا سررسید اسناد خزانه در آخرین تاریخ (دریافت‌شده از سایت فرابورس ایران) به عنوان نرخ بازده بدون ریسک استفاده می‌شود.
+* در صورتی که روزهای باقی‌مانده تا سررسید اختیار معامله کمتر از ۱۰ روز باشند، به دلیل احتمال خطا، مدل بلک، شولز و مرتون اعمال نخواهد شد.
+
+### دریافت گریکز برای یک نماد
+
+```python
+from fima.Options import get_greeks
+
+ticker_greeks = get_greeks(ticker='ضهرم4018')
+```
+#### ورودی
+* ticker: نماد اختیار معامله مد نظر
+* r_f: نرخ بازده بدون ریسک
+* minimum_required_history: کمینه دیتای مورد نیاز برای دارایی پایهجهت محاسبه نوسانات که به صورت پیش‌فرض ۳۰ روز در نظر گرفته شده است.
+
+#### خروجی
+* ticker_greeks: دلتا، تتا، گاما، وگا و رو برای نماد مد نظر 
+
+##### توجه 
+* در صورت عدم وارد کردن متغیر مربوط به نرخ بازده بدون ریسک، برای محاسبات مربوط به مدل بلک، شولز و مرتون از میانگین نرخ بازده تا سررسید اسناد خزانه در آخرین تاریخ (دریافت‌شده از سایت فرابورس ایران) به عنوان نرخ بازده بدون ریسک استفاده می‌شود.
+* در صورتی که روزهای باقی‌مانده تا سررسید اختیار معامله کمتر از ۱۰ روز باشند، به دلیل احتمال خطا، مدل بلک، شولز و مرتون اعمال نخواهد شد.
+
+### دریافت نوسانات ضمنی برای یک نماد
+
+```python
+from fima.Options import get_implied_volatility
+
+ticker_implied_volatility = get_implied_volatility(ticker='ضهرم4018')
+```
+#### ورودی
+* ticker: نماد اختیار معامله مد نظر
+* r_f: نرخ بازده بدون ریسک
+* minimum_required_history: کمینه دیتای مورد نیاز برای دارایی پایهجهت محاسبه نوسانات که به صورت پیش‌فرض ۳۰ روز در نظر گرفته شده است.
+
+#### خروجی
+* ticker_implied_volatility: نوسانات ضمنی برای نماد مد نظر 
+
+##### توجه 
+* در صورت عدم وارد کردن متغیر مربوط به نرخ بازده بدون ریسک، برای محاسبات مربوط به مدل بلک، شولز و مرتون از میانگین نرخ بازده تا سررسید اسناد خزانه در آخرین تاریخ (دریافت‌شده از سایت فرابورس ایران) به عنوان نرخ بازده بدون ریسک استفاده می‌شود.
+* در صورتی که روزهای باقی‌مانده تا سررسید اختیار معامله کمتر از ۱۰ روز باشند، به دلیل احتمال خطا، مدل بلک، شولز و مرتون اعمال نخواهد شد.
+
+### دریافت تمامی نمادهای دارای اختیار معامله
+
+```python
+from fima.Options import download_all_underlying_assets
+
+all_underlying_assets = download_all_underlying_assets(market='All')
+```
+#### ورودی
+* market: بازار معامله اختیار معامله
+  * 'TSE': بورس اوراق بهادار تهران
+  * 'IFB': فرابورس ایران
+  * 'All': تمامی اختیارهای معامله (حالت پیش‌فرض)
+
+#### خروجی
+* all_underlying_assets: اطلاعات مربوط به نمادهای دارای اختیار معامله
+
+#### توجه: در صورت عدم وارد کردن market، تمامی اختیارهای معامله دریافت خواهد شد. 
+
+### توابع مربوط به محاسبات
+
+```python
+from fima.Options import (calculate_black_scholes_merton, calculate_delta, calculate_vega,
+                          calculate_theta, calculate_gamma, calculate_rho)
+
+bsm_price = calculate_black_scholes_merton(s=550, k=28000, option_type='Call', t=71, sigma=0.9588, r_f=0.3372)
+delta = calculate_delta(s=550, k=28000, option_type='Call', t=71, sigma=0.9588, r_f=0.3372)
+theta = calculate_theta(s=550, k=28000, option_type='Call', t=71, sigma=0.9588, r_f=0.3372)
+gamma = calculate_gamma(s=550, k=28000, t=71, sigma=0.9588, r_f=0.3372)
+rho = calculate_rho(s=550, k=28000, option_type='Call', t=71, sigma=0.9588, r_f=0.3372)
+vega = calculate_vega(s=550, k=28000, t=71, sigma=0.9588, r_f=0.3372)
+```
+
+## توابع مربوط به اوراق درآمد ثابت
+### فراخوانی تمام توابع
+
+```python
+from fima.Bonds import *
+```
+
+### دریافت سابقه قیمت اختیار معامله و دارایی پایه آن
+
+```python
+from fima.Bonds import get_risk_free_rate
+
+risk_free_rate = get_risk_free_rate()
+```
+
+#### خروجی
+* risk_free_rate: میانگین نرخ بازده تا سررسید اسناد خزانه در آخرین تاریخ (دریافت‌شده از سایت فرابورس ایران)
+
+### دریافت اوراق درآمد ثابت بدون کوپن
+
+```python
+from fima.Bonds import get_all_bonds_without_coupons
+
+all_bonds_without_coupons = get_all_bonds_without_coupons(deprecated=True)
+```
+
+#### ورودی
+* deprecated:
+  * True: اوراق سررسید شده نیز در خروجی بیاید
+  * False: اوراق سررسید شده در خروجی نیاید
+#### خروجی
+* all_bonds_without_coupons: اطلاعات مربوط به اوراق درآمد ثابت بدون کوپن (دریاقت‌شده از سایت فرابورس ایران)
+
+### دریافت اوراق درآمد ثابت با کوپن
+
+```python
+from fima.Bonds import get_all_bonds_with_coupons
+
+all_bonds_with_coupons = get_all_bonds_with_coupons(deprecated=True)
+```
+
+#### ورودی
+* deprecated:
+  * True: اوراق سررسید شده نیز در خروجی بیاید
+  * False: اوراق سررسید شده در خروجی نیاید
+#### خروجی
+* all_bonds_without_coupons: اطلاعات مربوط به اوراق درآمد ثابت با کوپن (دریاقت‌شده از سایت فرابورس ایران)
+
+## نقشه راه
+1. [ ] عیب‌یابی و بهبود توابع پیاده‌سازی‌شده
+2. [ ] دریافت اطلاعات از سایت tgju
+3. [ ] دریافت اطلاعات از سایت tsetmc
+4. [ ] دریافت و پاکسازی اطلاعات سایت codal

fima-0.1.0/fima/Bonds.py

@@ -0,0 +1,102 @@
+import requests
+import pandas as pd
+import numpy as np
+from bs4 import BeautifulSoup
+from io import StringIO
+import jdatetime as jd
+
+
+def get_risk_free_rate() -> float:
+    all_bonds_without_coupons = get_all_bonds_without_coupons(deprecated=False)
+    all_t_notes = all_bonds_without_coupons[all_bonds_without_coupons['Ticker'].str.contains('سخاب|اخزا')].copy()
+    today_date = jd.date.today()
+    all_t_notes['DaysTillMaturity'] = (all_t_notes['MaturityDate'] - today_date).apply(lambda delta: delta.days)
+    last_traded_t_notes = all_t_notes[all_t_notes['LastTradedDate'] == all_t_notes['LastTradedDate'].max()]
+    rf = last_traded_t_notes['YTM'].mean()
+    return rf
+
+
+def get_all_bonds_without_coupons(deprecated: bool = True) -> pd.DataFrame:
+    url = "https://ifb.ir/YTM.aspx"
+
+    session = requests.Session()
+    response = session.get(url)
+
+    if response.status_code != 200:
+        print(f"Failed to access page. Status code: {response.status_code}")
+        return None
+
+    soup = BeautifulSoup(response.content, "html.parser")
+    table = soup.find("table", {"id": "ContentPlaceHolder1_grdytmforkhazaneh", "class": "KhazanehGrid"})
+
+    if table is None:
+        print("Table not found.")
+        return None
+
+    df_list = pd.read_html(StringIO(str(table)))
+    bonds_without_coupons = df_list[0]
+
+    if ~deprecated:
+        bonds_without_coupons = bonds_without_coupons[bonds_without_coupons['YTM'] != 'سررسید شده'].copy()
+
+    bonds_without_coupons.columns = ['Index', 'Ticker', 'LastTradedPrice', 'LastTradedDate', 'MaturityDate', 'YTM', 'SimpleReturn']
+
+    bonds_without_coupons['LastTradedDate'] = \
+        bonds_without_coupons['LastTradedDate'].apply(lambda str_date: jd.date(year=int(str_date[:4]),
+                                                                               month=int(str_date[5:7]),
+                                                                               day=int(str_date[8:])))
+
+    bonds_without_coupons['MaturityDate'] = \
+        bonds_without_coupons['MaturityDate'].apply(lambda str_date: jd.date(year=int(str_date[:4]),
+                                                                               month=int(str_date[5:7]),
+                                                                               day=int(str_date[8:])))
+
+    bonds_without_coupons['YTM'] = \
+        bonds_without_coupons['YTM'].apply(lambda str_ytm: float(str_ytm.replace('/', '.').replace('%', '')) / 100)
+    bonds_without_coupons['SimpleReturn'] = \
+        bonds_without_coupons['SimpleReturn'].apply(lambda str_ytm: float(str_ytm.replace('/', '.').replace('%', '')) / 100)
+
+    bonds_without_coupons.drop('Index', inplace=True, axis=1)
+    bonds_without_coupons.reset_index(inplace=True, drop=True)
+
+    return bonds_without_coupons
+
+
+def get_all_bonds_with_coupons(deprecated: bool = True) -> pd.DataFrame:
+    url = "https://ifb.ir/YTM.aspx"
+
+    session = requests.Session()
+    response = session.get(url)
+
+    if response.status_code != 200:
+        print(f"Failed to access page. Status code: {response.status_code}")
+        return None
+
+    soup = BeautifulSoup(response.content, "html.parser")
+    table = soup.find("table", {"id": "ContentPlaceHolder1_grdytm", "class": "mGrid"})
+
+    if table is None:
+        print("Table not found.")
+        return None
+
+    df_list = pd.read_html(StringIO(str(table)))
+    bonds_with_coupons = df_list[0]
+
+    if ~deprecated:
+        bonds_with_coupons = bonds_with_coupons[bonds_with_coupons['YTM'] != 'سررسید شده'].copy()
+
+    bonds_with_coupons.columns = ['Index', 'Ticker', 'LastTradedPrice', 'LastTradedDate', 'MaturityDate', 'YTM']
+
+    bonds_with_coupons['LastTradedDate'] = bonds_with_coupons['LastTradedDate'].apply(
+        lambda str_date: jd.date(year=int(str_date[:4]), month=int(str_date[5:7]), day=int(str_date[8:])) if pd.notna(str_date) else np.nan)
+
+    bonds_with_coupons['MaturityDate'] = bonds_with_coupons['MaturityDate'].apply(
+        lambda str_date: jd.date(year=int(str_date[:4]), month=int(str_date[5:7]), day=int(str_date[8:])) if str_date != '0' else np.nan)
+
+    bonds_with_coupons['YTM'] = bonds_with_coupons['YTM'].apply(
+        lambda str_ytm: float(str_ytm.replace('/', '.').replace('%', '')) / 100 if (pd.notna(str_ytm) and str_ytm != 'سررسید شده') else np.nan)
+
+    bonds_with_coupons.drop('Index', inplace=True, axis=1)
+    bonds_with_coupons.reset_index(inplace=True, drop=True)
+
+    return bonds_with_coupons