Metadata-Version: 2.1
Name: oxtapus
Version: 0.2.4
Summary: 
Home-page: https://github.com/yghaderi/oxtapus
Author: Yaghoub Ghadri
Author-email: y.ghaderi@outlook.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: aiohttp (>=3.8.5,<4.0.0)
Requires-Dist: beautifulsoup4 (>=4.12.2,<5.0.0)
Requires-Dist: hazm (>=0.9.3,<0.10.0)
Requires-Dist: html5lib (>=1.1,<2.0)
Requires-Dist: jdatetime (>=4.1.1,<5.0.0)
Requires-Dist: lxml (>=4.9.3,<5.0.0)
Requires-Dist: pandas (>=2.0.0,<3.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Project-URL: Repository, https://github.com/yghaderi/oxtapus
Description-Content-Type: text/markdown

# metafid
## oxtapus
این پکیج برای پوششِ بخشی از داده‌های موردِ نیاز در تصمیم‌هایِ مالی-اقتصادی توسعه داده شده است
## install 
#### mac , linux
```bash
python3 -m pip install oxtapus
```
#### windows
```bash
python -m pip install oxtapus
```

## data

### ise (Iran Stock Exchange)
#### TSETMC (tsetmc.com)
```python
from oxtapus.ise import TSETMC
tsetmc = TSETMC()

# ------------- market watch -------------
tsetmc.market_watch(stock=True) #stoock
tsetmc.market_watch(ifb_paye=True) # پایه‌یٍ فرابورس
tsetmc.market_watch(mortgage=True) # اوراقٍ مسکن
# cum_right, bond, option, futures, etf, commodity دیگر پارامترها شامل اینها است که می‌توان با-هم هم افزوده شوند 
tsetmc.market_watch(stock=True, cum_right=True,etf=True )

# ------------- option market watch -------------
tsetmc.option_market_watch()

# ------------- instrument info -------------
tsetmc.stock_info()
tsetmc.option_info()
tsetmc.etf_info()

# ------------- history price -------------
tsetmc.hist_price(symbol_far= "شبندر") 
# اگر میخواهید بر اساس کد نماد داده دریافت کنید
tsetmc.hist_price(ins_code= "35366681030756042") 

# ------------- adjust history price -------------
tsetmc.adj_hist_price(symbol_far= "شبندر") 
# اگر میخواهید بر اساس کد نماد داده دریافت کنید
tsetmc.adj_hist_price(ins_code= "35366681030756042") 

# ------------- share change -------------
tsetmc.share_change(symbol_far= "شبندر") 
# اگر میخواهید بر اساس کد نماد داده دریافت کنید
tsetmc.share_change(ins_code= "35366681030756042") 

# ------------- index  -------------
tsetmc.all_index() # همه‌یِ شاخص‌ها-شاملِ نام، کد، و مقدار
tsetmc.index_ticker_symbols(index_code=13235969998952202) # نمادهایی که شاخصِ *** دنبال می‌کند
tsetmc.index_hist(index_code=13235969998952202)

# ------------- intraday trade -------------
tsetmc.intraday_trades(symbol_far= "شبندر") 
# اگر میخواهید بر اساس کد نماد داده دریافت کنید
tsetmc.intraday_trades(ins_code= "35366681030756042") 

# برای دریافتِ معاملاتِ درو-روزی بر اساسِ تایم-فریم
# T به معنایِ دقیقه
# S به معنای ثانیه.
tsetmc.intraday_trades_base_timeframe(symbol_far= "شبندر", timeframe="5T") 
# اگر میخواهید بر اساس کد نماد داده دریافت کنید
tsetmc.intraday_trades_base_timeframe(ins_code= "35366681030756042",timeframe= "5T") 

# ------------- last ins info -------------
# آخرین اطلاعات مربوط به قیمت و حجم و ارزش معامله‌هایِ نماد بر رویِ تابلو
tsetmc.last_ins_info(symbol_far= "شبندر") 
# اگر میخواهید بر اساس کد نماد داده دریافت کنید
tsetmc.last_ins_info(ins_code= "35366681030756042") 

```
### Codal(codal.ir)
###### beta version!
```python
from oxtapus.ise import Codal
codal = Codal()
codal.symbol = "شبندر"

# ------------- income-statements -------------
codal.income_statements() # صورتِ سود یا زیان
codal.balance_sheet() # صورت-وضعیتِ مالی
```

### Rahavard
```python
from oxtapus.ise import Rahavard
rah = Rahavard()

# ------------- balance-sheet -------------
rah.balance_sheet("شبندر")

```
### econ 
### TGJU (tgju.org)
```python
from oxtapus.econ import TGJU
tgju = TGJU()

# ------------- sekke -------------
tgju.sekke_emami() # امامی
tgju.nim_sekke() # نیم
tgju.rob_sekke() # رُبع
tgju.ons() # xauusd (اُنس جهانی)

# ------------- currency -------------
tgju.usd_irr()
```
### ICB (Iran Central Bank)
