Metadata-Version: 2.1
Name: codal-tsetmc
Version: 1.6.0
Summary: Data Downloader for Codal and Tehran stock market
Home-page: https://mohsenebrahimyir.github.io/codal-tsetmc/
License: MIT
Author: Mohsen Ebrahimi
Author-email: mohsenebrahimy.ir@gmail.com
Requires-Python: >=3.8.1,<4.0.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: PyYAML (>=6.0.2,<7.0.0)
Requires-Dist: SQLAlchemy (>=2.0.32,<3.0.0)
Requires-Dist: aiohttp (>=3.10.5,<4.0.0)
Requires-Dist: aiosignal (>=1.3.1,<2.0.0)
Requires-Dist: beautifulsoup4 (>=4.12.3,<5.0.0)
Requires-Dist: html5lib (>=1.1,<2.0)
Requires-Dist: jalali-pandas (>=0.2.2,<0.3.0)
Requires-Dist: lxml (>=5.3.0,<6.0.0)
Requires-Dist: nest-asyncio (>=1.6.0,<2.0.0)
Requires-Dist: pandas (>=2.2.2,<3.0.0)
Requires-Dist: psycopg2-binary (>=2.9.9,<3.0.0)
Requires-Dist: requests (>=2.32.3,<3.0.0)
Project-URL: Repository, https://github.com/mohsenebrahimyir/codal-tsetmc.git
Description-Content-Type: text/markdown

# کدال و بورس در پایتون

این پکیچ برای ذخیره داده‌های سایت کدال و بازار سرمایه برای اهداف تحلیل بنیادی تهیه شده است.

- [آموزش بسته](https://mohsenebrahimyir.github.io/codal-tsetmc/)
- [تلگرام @codal_tsetmc_package](https://t.me/codal_tsetmc_package)
- [ایتا @codal_tsetmc_package](https://eitaa.com/codal_tsetmc_package)

## هشدار

اگر این متن را میبینید یعنی این پکیج درحال توسعه است و قابلیت استفاده در پروژه‌های مهم را ندارد.

```bash
# python3 -m pip install --upgrade build
python3 -m build
```

```bash
# python3 -m pip install --upgrade twine
python3 -m twine upload --repository pypi dist/*
```

## پایگاه داده

### TSETMC

- [X] `tehran_stocks`: الهام از بسته
- [X] `stock`: لیست تمام سهام‌ها و صندوق‌ها و ...
- [X] `stock_capital`: پایگاه داده افزایش سرمایه
  - باید دقت کنیم که بعضی از افزایش سرمایه‌‌های سایت tsetmc بروز نیست و باید برای محاسبه مقدار دقیق از صورت‌های مالی شرکت‌ها استفاده کرد.
- [X] `stock_price`: قیمت و حجم معاملات روزانه
- [X] `stock_group`:
### CODAL

- [X] `company`: لیست تمام شرکت‌ها
- [X] `company_state`: وضعیت شرکت‌ها
- [X] `company_type`: نوع شرکت‌ها
- [X] `report_type`: گروه اطلاعیه‌ها
- [X] `letter_type`: نوع گزارش
- [X] `auditor`: حسابرس‌ها
- [X] `financial_year`: سال مالی‌ها
- [X] `letter`: گزارشات مالی

## نصب پکیج

برای استفاده از این بسته پیشنهاد می‌شود از محیط مجازی استفاده کنید.

```bash
python -m venv .venv
```

فعال سازی محیط مجازی در لینوکس

```bash
source .venv/bin/activate
```

فعال سازی محیط مجازی در ویندوز

```cmd
> .\venv\Scripts\activate
```

نصب از `pypi`:

```bash
pip install -U codal-tsetmc
```

نصب از نسخه در حال توسعه `github`

```bash
pip install git+https://github.com/mohsenebrahimyir/codal-tsetmc.git
```

