Alilnvest-Codal 1.5.4__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- alilnvest_codal-1.5.4/NOTICE.md +14 -0
- alilnvest_codal-1.5.4/PKG-INFO +183 -0
- alilnvest_codal-1.5.4/README.md +151 -0
- alilnvest_codal-1.5.4/codal13_fixed_1.5.4-LICENSE +21 -0
- alilnvest_codal-1.5.4/pyproject.toml +55 -0
- alilnvest_codal-1.5.4/setup.cfg +4 -0
- alilnvest_codal-1.5.4/src/Alilnvest_Codal.egg-info/PKG-INFO +183 -0
- alilnvest_codal-1.5.4/src/Alilnvest_Codal.egg-info/SOURCES.txt +38 -0
- alilnvest_codal-1.5.4/src/Alilnvest_Codal.egg-info/dependency_links.txt +1 -0
- alilnvest_codal-1.5.4/src/Alilnvest_Codal.egg-info/requires.txt +15 -0
- alilnvest_codal-1.5.4/src/Alilnvest_Codal.egg-info/top_level.txt +1 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/__init__.py +167 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/_version.py +2 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/amendments.py +82 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/analytics.py +174 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/api.py +69 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/audit.py +422 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/automation.py +175 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/cache.py +158 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/checks.py +784 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/codal.py +71 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/config.py +105 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/datasource.py +152 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/endpoints.py +29 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/excel.py +149 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/exceptions.py +96 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/formulas.py +333 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/frames.py +139 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/health.py +47 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/http.py +752 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/letter_codes.py +77 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/models.py +241 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/parsers.py +24 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/progress.py +163 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/py.typed +0 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/reports.py +1199 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/search.py +279 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/sheets.py +305 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/store.py +127 -0
- alilnvest_codal-1.5.4/src/alilnvest_codal/utils.py +179 -0
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Alilnvest-Codal — Brand and Distribution Notice
|
|
2
|
+
|
|
3
|
+
این پروژه با نام انتشار **Alilnvest-Codal** و برند عمومی **Alilnvest** ارائه میشود.
|
|
4
|
+
|
|
5
|
+
نامهای پیشنهادی رسمی برای خروجیها:
|
|
6
|
+
|
|
7
|
+
- Alilnvest Codal Report
|
|
8
|
+
- Alilnvest Market Intelligence
|
|
9
|
+
- کانال بله: Alilnvest
|
|
10
|
+
- کانال تلگرام: Alilnvest
|
|
11
|
+
|
|
12
|
+
نام `alilnvest_codal` فقط برای سازگاری با برنامههای قدیمی حفظ شده است و نام محصول جدید نیست.
|
|
13
|
+
|
|
14
|
+
این notice جایگزین LICENSE نیست. شرایط حقوقی استفاده، کپی، تغییر و توزیع را باید از فایل `LICENSE` بخوانید. برای انتشار عمومی در GitHub، هیچ ادعایی مبنی بر غیرقابلکپیبودن کد مطرح نمیشود؛ کد عمومی قابل مشاهده است. برای حفاظت انحصاری، مخزن خصوصی یا مجوز محدودکنندهٔ بررسیشده توسط مشاور حقوقی لازم است.
|
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: Alilnvest-Codal
|
|
3
|
+
Version: 1.5.4
|
|
4
|
+
Summary: Alilnvest-Codal — a resilient, typed Python client for Iranian Codal disclosures
|
|
5
|
+
License-Expression: MIT
|
|
6
|
+
Keywords: alilnvest,codal,iran,bourse,financial-statements,pandas
|
|
7
|
+
Classifier: Programming Language :: Python :: 3
|
|
8
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
9
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
10
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
13
|
+
Classifier: Operating System :: OS Independent
|
|
14
|
+
Requires-Python: >=3.10
|
|
15
|
+
Description-Content-Type: text/markdown
|
|
16
|
+
License-File: codal13_fixed_1.5.4-LICENSE
|
|
17
|
+
License-File: NOTICE.md
|
|
18
|
+
Requires-Dist: requests>=2.28
|
|
19
|
+
Requires-Dist: pandas>=2.0
|
|
20
|
+
Requires-Dist: lxml>=5.0
|
|
21
|
+
Requires-Dist: beautifulsoup4>=4.11
|
|
22
|
+
Requires-Dist: openpyxl>=3.1
|
|
23
|
+
Requires-Dist: xlrd>=2.0.1
|
|
24
|
+
Requires-Dist: jdatetime>=5.0
|
|
25
|
+
Provides-Extra: async
|
|
26
|
+
Requires-Dist: httpx>=0.27; extra == "async"
|
|
27
|
+
Provides-Extra: quality
|
|
28
|
+
Requires-Dist: ruff>=0.6; extra == "quality"
|
|
29
|
+
Requires-Dist: mypy>=1.11; extra == "quality"
|
|
30
|
+
Requires-Dist: httpx>=0.27; extra == "quality"
|
|
31
|
+
Dynamic: license-file
|
|
32
|
+
|
|
33
|
+
# Alilnvest-Codal
|
|
34
|
+
|
|
35
|
+
**A resilient Python client for Iranian Codal disclosures, financial statements, caching, reporting, and rate-limit-aware automation.**
|
|
36
|
+
|
|
37
|
+
نام انتشار این پروژه **Alilnvest-Codal** است و برند رسمی خروجیها **Alilnvest** است.
|
|
38
|
+
|
|
39
|
+
این کتابخانه برای رباتهای تحلیل بازار ایران، سرویسهای backfill، اسکریپتهای بنیادی و کانالهای اطلاعرسانی طراحی شده و مستقل از پروژههای c5/c6 است.
|
|
40
|
+
|
|
41
|
+
## API و بازهٔ تاریخ
|
|
42
|
+
|
|
43
|
+
این نسخه کاملاً مستقل است و فقط با namespace `alilnvest_codal` منتشر میشود. نام و import قدیمی `namespace قدیمی` داخل این بسته وجود ندارد.
|
|
44
|
+
|
|
45
|
+
```python
|
|
46
|
+
import alilnvest_codal as cp
|
|
47
|
+
|
|
48
|
+
reports = cp.income_statement("فولاد", max_reports=5)
|
|
49
|
+
print(reports[0].period_end_to_date)
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
تاریخها hard-code نشدهاند. در صورتهای مالی، جستوجوی اطلاعیه و عملیات اتوماسیون میتوان بازهٔ دلخواه جلالی را تعیین کرد:
|
|
53
|
+
|
|
54
|
+
```python
|
|
55
|
+
reports = cp.income_statement(
|
|
56
|
+
"فولاد",
|
|
57
|
+
from_date="1403/01/01",
|
|
58
|
+
to_date="1403/12/30",
|
|
59
|
+
max_reports=20,
|
|
60
|
+
)
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
پارامترهای `from_date` و `to_date` با قالب `YYYY/MM/DD` اعتبارسنجی میشوند. اگر تاریخ داده نشود، `from_date` از تنظیم پیشفرض کتابخانه و `to_date` از تاریخ روز جلالی استفاده میکند. برای کنترل دقیق backfill همیشه هر دو تاریخ را صریح ارسال کنید.
|
|
64
|
+
|
|
65
|
+
## نصب
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
python3 -m venv .venv
|
|
69
|
+
. .venv/bin/activate
|
|
70
|
+
python -m pip install --upgrade pip
|
|
71
|
+
python -m pip install .
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
برای قابلیتهای async:
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
python -m pip install '.[async]'
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## استفادهٔ سریع
|
|
81
|
+
|
|
82
|
+
```python
|
|
83
|
+
import alilnvest_codal as cp
|
|
84
|
+
|
|
85
|
+
income = cp.income_statement("توسن")
|
|
86
|
+
balance = cp.balance_sheet("توسن")
|
|
87
|
+
cashflow = cp.cash_flow_statement("توسن")
|
|
88
|
+
letters = cp.search_letters("توسن", max_pages=1)
|
|
89
|
+
snapshot = cp.financial_snapshot("توسن")
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## خطاهای ساختاریافته
|
|
93
|
+
|
|
94
|
+
```python
|
|
95
|
+
try:
|
|
96
|
+
reports = cp.income_statement("نماد_نامعتبر")
|
|
97
|
+
except cp.SymbolNotFoundError as exc:
|
|
98
|
+
print(exc.symbol)
|
|
99
|
+
except cp.RateLimitError as exc:
|
|
100
|
+
print(exc.retry_after)
|
|
101
|
+
except cp.NetworkError as exc:
|
|
102
|
+
print(exc.status_code)
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## نرخ درخواست، retry و circuit breaker
|
|
106
|
+
|
|
107
|
+
```python
|
|
108
|
+
import alilnvest_codal as cp
|
|
109
|
+
|
|
110
|
+
cp.configure(
|
|
111
|
+
min_delay=2.0,
|
|
112
|
+
max_delay=3.5,
|
|
113
|
+
max_retries=2,
|
|
114
|
+
symbol_min_delay=15,
|
|
115
|
+
symbol_max_delay=20,
|
|
116
|
+
)
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
کتابخانه پاسخ `Retry-After` را رعایت میکند، خطاهای موقت را با backoff کنترل میکند و در شرایط شکست پیاپی circuit breaker دارد. هیچ نرخ ثابتی مسدودنشدن IP را تضمین نمیکند؛ برای چند پردازه یا چند سرویس روی یک IP از صف مرکزی استفاده کنید.
|
|
120
|
+
|
|
121
|
+
## کش و تنظیمات پیشنهادی
|
|
122
|
+
|
|
123
|
+
```env
|
|
124
|
+
CODAL_CACHE_DIR=~/bourse_reports/codal_cache
|
|
125
|
+
CODAL_FROM_JDATE=1403/01/01
|
|
126
|
+
CODAL_TO_JDATE=1405/12/29
|
|
127
|
+
CODAL_TIMEOUT=45
|
|
128
|
+
CODAL_MAX_RETRIES=3
|
|
129
|
+
CODAL_LOG_LEVEL=INFO
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
کتابخانه قبل از شبکه cache را بررسی میکند و در صورت شکست، تاریخچهٔ سالم را با دادهٔ ناقص جایگزین نمیکند.
|
|
133
|
+
|
|
134
|
+
## اتصال به کانالهای Alilnvest
|
|
135
|
+
|
|
136
|
+
کتابخانه توکن پیامرسان را داخل کد قرار نمیدهد. ارسال پیام باید در adapter برنامه انجام شود و secrets فقط در `.env` خصوصی باشند.
|
|
137
|
+
|
|
138
|
+
### کانال بله
|
|
139
|
+
|
|
140
|
+
```env
|
|
141
|
+
ALILNVEST_CHANNEL_NAME=Alilnvest
|
|
142
|
+
BALE_BOT_TOKEN=توکن_ربات_بله
|
|
143
|
+
BALE_CHANNEL_ID=@شناسه_کانال_بله
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
ربات باید در کانال بلهٔ **Alilnvest** عضو و دارای مجوز ارسال باشد.
|
|
147
|
+
|
|
148
|
+
### کانال تلگرام
|
|
149
|
+
|
|
150
|
+
```env
|
|
151
|
+
ALILNVEST_CHANNEL_NAME=Alilnvest
|
|
152
|
+
TELEGRAM_BOT_TOKEN=توکن_ربات_تلگرام
|
|
153
|
+
TELEGRAM_CHANNEL_ID=@شناسه_کانال_تلگرام
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
ربات باید در کانال تلگرام **Alilnvest** ادمین باشد. نام رسمی برند و کانالها در کپشنها، گزارشها و watermarkها نیز باید `Alilnvest` باشد.
|
|
157
|
+
|
|
158
|
+
## ساختار انتشار
|
|
159
|
+
|
|
160
|
+
- `src/alilnvest_codal/`: implementation سازگار با پروژههای قبلی
|
|
161
|
+
- `src/alilnvest_codal/`: namespace جدید برندشده
|
|
162
|
+
- `README.md`: راهنمای اصلی
|
|
163
|
+
- `MIGRATION.md`: راهنمای سازگاری
|
|
164
|
+
- `CHANGELOG.md`: تاریخچهٔ نسخه
|
|
165
|
+
- `NOTICE.md`: مالکیت و قواعد برند
|
|
166
|
+
- `LICENSE`: مجوز استفاده
|
|
167
|
+
|
|
168
|
+
فایلهای تست، fixture، probe، diagnose و اسکریپتهای توسعه از بستهٔ انتشار حذف شدهاند. تستها باید در مخزن توسعهٔ خصوصی نگهداری شوند، نه در archive تولیدی.
|
|
169
|
+
|
|
170
|
+
## دربارهٔ کپیبرداری
|
|
171
|
+
|
|
172
|
+
کدی که در GitHub عمومی قرار میگیرد از نظر فنی قابل مشاهده و قابل کپی است. هیچ obfuscation واقعی این موضوع را حل نمیکند و obfuscation دیباگ، امنیت و نگهداری را ضعیف میکند. این بسته بهجای آن versioning، metadata، `NOTICE.md` و برند مشخص دارد. اگر مالکیت انحصاری لازم است، repository را private نگه دارید و قبل از تغییر MIT به مجوز source-available محدودکننده، بررسی حقوقی انجام دهید.
|
|
173
|
+
|
|
174
|
+
## هشدار استفاده
|
|
175
|
+
|
|
176
|
+
این پروژه ابزار دریافت و پردازش داده است، نه توصیهٔ سرمایهگذاری. کیفیت و دسترسپذیری Codal ممکن است تغییر کند. قبل از استفادهٔ تولیدی، rate limit، مجوز دسترسی، cache و قوانین داده را در محیط خود بررسی کنید.
|
|
177
|
+
|
|
178
|
+
## برند رسمی
|
|
179
|
+
|
|
180
|
+
- نام محصول: **Alilnvest-Codal**
|
|
181
|
+
- نام کانالها: **Alilnvest**
|
|
182
|
+
- نام خروجی: **Alilnvest Codal Report**
|
|
183
|
+
- نام پیشنهادی کپشن: **Alilnvest Market Intelligence**
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
# Alilnvest-Codal
|
|
2
|
+
|
|
3
|
+
**A resilient Python client for Iranian Codal disclosures, financial statements, caching, reporting, and rate-limit-aware automation.**
|
|
4
|
+
|
|
5
|
+
نام انتشار این پروژه **Alilnvest-Codal** است و برند رسمی خروجیها **Alilnvest** است.
|
|
6
|
+
|
|
7
|
+
این کتابخانه برای رباتهای تحلیل بازار ایران، سرویسهای backfill، اسکریپتهای بنیادی و کانالهای اطلاعرسانی طراحی شده و مستقل از پروژههای c5/c6 است.
|
|
8
|
+
|
|
9
|
+
## API و بازهٔ تاریخ
|
|
10
|
+
|
|
11
|
+
این نسخه کاملاً مستقل است و فقط با namespace `alilnvest_codal` منتشر میشود. نام و import قدیمی `namespace قدیمی` داخل این بسته وجود ندارد.
|
|
12
|
+
|
|
13
|
+
```python
|
|
14
|
+
import alilnvest_codal as cp
|
|
15
|
+
|
|
16
|
+
reports = cp.income_statement("فولاد", max_reports=5)
|
|
17
|
+
print(reports[0].period_end_to_date)
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
تاریخها hard-code نشدهاند. در صورتهای مالی، جستوجوی اطلاعیه و عملیات اتوماسیون میتوان بازهٔ دلخواه جلالی را تعیین کرد:
|
|
21
|
+
|
|
22
|
+
```python
|
|
23
|
+
reports = cp.income_statement(
|
|
24
|
+
"فولاد",
|
|
25
|
+
from_date="1403/01/01",
|
|
26
|
+
to_date="1403/12/30",
|
|
27
|
+
max_reports=20,
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
پارامترهای `from_date` و `to_date` با قالب `YYYY/MM/DD` اعتبارسنجی میشوند. اگر تاریخ داده نشود، `from_date` از تنظیم پیشفرض کتابخانه و `to_date` از تاریخ روز جلالی استفاده میکند. برای کنترل دقیق backfill همیشه هر دو تاریخ را صریح ارسال کنید.
|
|
32
|
+
|
|
33
|
+
## نصب
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
python3 -m venv .venv
|
|
37
|
+
. .venv/bin/activate
|
|
38
|
+
python -m pip install --upgrade pip
|
|
39
|
+
python -m pip install .
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
برای قابلیتهای async:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
python -m pip install '.[async]'
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## استفادهٔ سریع
|
|
49
|
+
|
|
50
|
+
```python
|
|
51
|
+
import alilnvest_codal as cp
|
|
52
|
+
|
|
53
|
+
income = cp.income_statement("توسن")
|
|
54
|
+
balance = cp.balance_sheet("توسن")
|
|
55
|
+
cashflow = cp.cash_flow_statement("توسن")
|
|
56
|
+
letters = cp.search_letters("توسن", max_pages=1)
|
|
57
|
+
snapshot = cp.financial_snapshot("توسن")
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## خطاهای ساختاریافته
|
|
61
|
+
|
|
62
|
+
```python
|
|
63
|
+
try:
|
|
64
|
+
reports = cp.income_statement("نماد_نامعتبر")
|
|
65
|
+
except cp.SymbolNotFoundError as exc:
|
|
66
|
+
print(exc.symbol)
|
|
67
|
+
except cp.RateLimitError as exc:
|
|
68
|
+
print(exc.retry_after)
|
|
69
|
+
except cp.NetworkError as exc:
|
|
70
|
+
print(exc.status_code)
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## نرخ درخواست، retry و circuit breaker
|
|
74
|
+
|
|
75
|
+
```python
|
|
76
|
+
import alilnvest_codal as cp
|
|
77
|
+
|
|
78
|
+
cp.configure(
|
|
79
|
+
min_delay=2.0,
|
|
80
|
+
max_delay=3.5,
|
|
81
|
+
max_retries=2,
|
|
82
|
+
symbol_min_delay=15,
|
|
83
|
+
symbol_max_delay=20,
|
|
84
|
+
)
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
کتابخانه پاسخ `Retry-After` را رعایت میکند، خطاهای موقت را با backoff کنترل میکند و در شرایط شکست پیاپی circuit breaker دارد. هیچ نرخ ثابتی مسدودنشدن IP را تضمین نمیکند؛ برای چند پردازه یا چند سرویس روی یک IP از صف مرکزی استفاده کنید.
|
|
88
|
+
|
|
89
|
+
## کش و تنظیمات پیشنهادی
|
|
90
|
+
|
|
91
|
+
```env
|
|
92
|
+
CODAL_CACHE_DIR=~/bourse_reports/codal_cache
|
|
93
|
+
CODAL_FROM_JDATE=1403/01/01
|
|
94
|
+
CODAL_TO_JDATE=1405/12/29
|
|
95
|
+
CODAL_TIMEOUT=45
|
|
96
|
+
CODAL_MAX_RETRIES=3
|
|
97
|
+
CODAL_LOG_LEVEL=INFO
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
کتابخانه قبل از شبکه cache را بررسی میکند و در صورت شکست، تاریخچهٔ سالم را با دادهٔ ناقص جایگزین نمیکند.
|
|
101
|
+
|
|
102
|
+
## اتصال به کانالهای Alilnvest
|
|
103
|
+
|
|
104
|
+
کتابخانه توکن پیامرسان را داخل کد قرار نمیدهد. ارسال پیام باید در adapter برنامه انجام شود و secrets فقط در `.env` خصوصی باشند.
|
|
105
|
+
|
|
106
|
+
### کانال بله
|
|
107
|
+
|
|
108
|
+
```env
|
|
109
|
+
ALILNVEST_CHANNEL_NAME=Alilnvest
|
|
110
|
+
BALE_BOT_TOKEN=توکن_ربات_بله
|
|
111
|
+
BALE_CHANNEL_ID=@شناسه_کانال_بله
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
ربات باید در کانال بلهٔ **Alilnvest** عضو و دارای مجوز ارسال باشد.
|
|
115
|
+
|
|
116
|
+
### کانال تلگرام
|
|
117
|
+
|
|
118
|
+
```env
|
|
119
|
+
ALILNVEST_CHANNEL_NAME=Alilnvest
|
|
120
|
+
TELEGRAM_BOT_TOKEN=توکن_ربات_تلگرام
|
|
121
|
+
TELEGRAM_CHANNEL_ID=@شناسه_کانال_تلگرام
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
ربات باید در کانال تلگرام **Alilnvest** ادمین باشد. نام رسمی برند و کانالها در کپشنها، گزارشها و watermarkها نیز باید `Alilnvest` باشد.
|
|
125
|
+
|
|
126
|
+
## ساختار انتشار
|
|
127
|
+
|
|
128
|
+
- `src/alilnvest_codal/`: implementation سازگار با پروژههای قبلی
|
|
129
|
+
- `src/alilnvest_codal/`: namespace جدید برندشده
|
|
130
|
+
- `README.md`: راهنمای اصلی
|
|
131
|
+
- `MIGRATION.md`: راهنمای سازگاری
|
|
132
|
+
- `CHANGELOG.md`: تاریخچهٔ نسخه
|
|
133
|
+
- `NOTICE.md`: مالکیت و قواعد برند
|
|
134
|
+
- `LICENSE`: مجوز استفاده
|
|
135
|
+
|
|
136
|
+
فایلهای تست، fixture، probe، diagnose و اسکریپتهای توسعه از بستهٔ انتشار حذف شدهاند. تستها باید در مخزن توسعهٔ خصوصی نگهداری شوند، نه در archive تولیدی.
|
|
137
|
+
|
|
138
|
+
## دربارهٔ کپیبرداری
|
|
139
|
+
|
|
140
|
+
کدی که در GitHub عمومی قرار میگیرد از نظر فنی قابل مشاهده و قابل کپی است. هیچ obfuscation واقعی این موضوع را حل نمیکند و obfuscation دیباگ، امنیت و نگهداری را ضعیف میکند. این بسته بهجای آن versioning، metadata، `NOTICE.md` و برند مشخص دارد. اگر مالکیت انحصاری لازم است، repository را private نگه دارید و قبل از تغییر MIT به مجوز source-available محدودکننده، بررسی حقوقی انجام دهید.
|
|
141
|
+
|
|
142
|
+
## هشدار استفاده
|
|
143
|
+
|
|
144
|
+
این پروژه ابزار دریافت و پردازش داده است، نه توصیهٔ سرمایهگذاری. کیفیت و دسترسپذیری Codal ممکن است تغییر کند. قبل از استفادهٔ تولیدی، rate limit، مجوز دسترسی، cache و قوانین داده را در محیط خود بررسی کنید.
|
|
145
|
+
|
|
146
|
+
## برند رسمی
|
|
147
|
+
|
|
148
|
+
- نام محصول: **Alilnvest-Codal**
|
|
149
|
+
- نام کانالها: **Alilnvest**
|
|
150
|
+
- نام خروجی: **Alilnvest Codal Report**
|
|
151
|
+
- نام پیشنهادی کپشن: **Alilnvest Market Intelligence**
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=77"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "Alilnvest-Codal"
|
|
7
|
+
version = "1.5.4"
|
|
8
|
+
description = "Alilnvest-Codal — a resilient, typed Python client for Iranian Codal disclosures"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.10"
|
|
11
|
+
license = "MIT"
|
|
12
|
+
license-files = ["codal13_fixed_1.5.4-LICENSE", "NOTICE.md"]
|
|
13
|
+
keywords = ["alilnvest", "codal", "iran", "bourse", "financial-statements", "pandas"]
|
|
14
|
+
classifiers = [
|
|
15
|
+
"Programming Language :: Python :: 3",
|
|
16
|
+
"Programming Language :: Python :: 3.10",
|
|
17
|
+
"Programming Language :: Python :: 3.11",
|
|
18
|
+
"Programming Language :: Python :: 3.12",
|
|
19
|
+
"Programming Language :: Python :: 3.13",
|
|
20
|
+
"Programming Language :: Python :: 3.14",
|
|
21
|
+
"Operating System :: OS Independent",
|
|
22
|
+
]
|
|
23
|
+
dependencies = [
|
|
24
|
+
"requests>=2.28",
|
|
25
|
+
"pandas>=2.0",
|
|
26
|
+
"lxml>=5.0",
|
|
27
|
+
"beautifulsoup4>=4.11",
|
|
28
|
+
"openpyxl>=3.1",
|
|
29
|
+
"xlrd>=2.0.1",
|
|
30
|
+
"jdatetime>=5.0",
|
|
31
|
+
]
|
|
32
|
+
|
|
33
|
+
[project.optional-dependencies]
|
|
34
|
+
# فقط برایِ CodalHTTPClient/Codal facade و توابعِ async لازمه -- بقیهی کتابخانه
|
|
35
|
+
# (income_statement/balance_sheet/search_letters/...) کاملاً بر پایهیِ requests
|
|
36
|
+
# کار میکنه و بدونِ httpx هم نصب/ایمپورت/اجرا میشه.
|
|
37
|
+
async = ["httpx>=0.27"]
|
|
38
|
+
quality = ["ruff>=0.6", "mypy>=1.11", "httpx>=0.27"]
|
|
39
|
+
|
|
40
|
+
[tool.setuptools.packages.find]
|
|
41
|
+
where = ["src"]
|
|
42
|
+
|
|
43
|
+
[tool.setuptools.package-data]
|
|
44
|
+
alilnvest_codal = ["py.typed"]
|
|
45
|
+
|
|
46
|
+
[tool.ruff]
|
|
47
|
+
target-version = "py310"
|
|
48
|
+
|
|
49
|
+
[tool.ruff.lint]
|
|
50
|
+
select = ["E4", "E7", "E9", "F"]
|
|
51
|
+
|
|
52
|
+
[tool.ruff.lint.per-file-ignores]
|
|
53
|
+
# The package initializer intentionally imports the legacy API before adding
|
|
54
|
+
# compatibility aliases at the package boundary.
|
|
55
|
+
"src/alilnvest_codal/__init__.py" = ["E402"]
|
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: Alilnvest-Codal
|
|
3
|
+
Version: 1.5.4
|
|
4
|
+
Summary: Alilnvest-Codal — a resilient, typed Python client for Iranian Codal disclosures
|
|
5
|
+
License-Expression: MIT
|
|
6
|
+
Keywords: alilnvest,codal,iran,bourse,financial-statements,pandas
|
|
7
|
+
Classifier: Programming Language :: Python :: 3
|
|
8
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
9
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
10
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
13
|
+
Classifier: Operating System :: OS Independent
|
|
14
|
+
Requires-Python: >=3.10
|
|
15
|
+
Description-Content-Type: text/markdown
|
|
16
|
+
License-File: codal13_fixed_1.5.4-LICENSE
|
|
17
|
+
License-File: NOTICE.md
|
|
18
|
+
Requires-Dist: requests>=2.28
|
|
19
|
+
Requires-Dist: pandas>=2.0
|
|
20
|
+
Requires-Dist: lxml>=5.0
|
|
21
|
+
Requires-Dist: beautifulsoup4>=4.11
|
|
22
|
+
Requires-Dist: openpyxl>=3.1
|
|
23
|
+
Requires-Dist: xlrd>=2.0.1
|
|
24
|
+
Requires-Dist: jdatetime>=5.0
|
|
25
|
+
Provides-Extra: async
|
|
26
|
+
Requires-Dist: httpx>=0.27; extra == "async"
|
|
27
|
+
Provides-Extra: quality
|
|
28
|
+
Requires-Dist: ruff>=0.6; extra == "quality"
|
|
29
|
+
Requires-Dist: mypy>=1.11; extra == "quality"
|
|
30
|
+
Requires-Dist: httpx>=0.27; extra == "quality"
|
|
31
|
+
Dynamic: license-file
|
|
32
|
+
|
|
33
|
+
# Alilnvest-Codal
|
|
34
|
+
|
|
35
|
+
**A resilient Python client for Iranian Codal disclosures, financial statements, caching, reporting, and rate-limit-aware automation.**
|
|
36
|
+
|
|
37
|
+
نام انتشار این پروژه **Alilnvest-Codal** است و برند رسمی خروجیها **Alilnvest** است.
|
|
38
|
+
|
|
39
|
+
این کتابخانه برای رباتهای تحلیل بازار ایران، سرویسهای backfill، اسکریپتهای بنیادی و کانالهای اطلاعرسانی طراحی شده و مستقل از پروژههای c5/c6 است.
|
|
40
|
+
|
|
41
|
+
## API و بازهٔ تاریخ
|
|
42
|
+
|
|
43
|
+
این نسخه کاملاً مستقل است و فقط با namespace `alilnvest_codal` منتشر میشود. نام و import قدیمی `namespace قدیمی` داخل این بسته وجود ندارد.
|
|
44
|
+
|
|
45
|
+
```python
|
|
46
|
+
import alilnvest_codal as cp
|
|
47
|
+
|
|
48
|
+
reports = cp.income_statement("فولاد", max_reports=5)
|
|
49
|
+
print(reports[0].period_end_to_date)
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
تاریخها hard-code نشدهاند. در صورتهای مالی، جستوجوی اطلاعیه و عملیات اتوماسیون میتوان بازهٔ دلخواه جلالی را تعیین کرد:
|
|
53
|
+
|
|
54
|
+
```python
|
|
55
|
+
reports = cp.income_statement(
|
|
56
|
+
"فولاد",
|
|
57
|
+
from_date="1403/01/01",
|
|
58
|
+
to_date="1403/12/30",
|
|
59
|
+
max_reports=20,
|
|
60
|
+
)
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
پارامترهای `from_date` و `to_date` با قالب `YYYY/MM/DD` اعتبارسنجی میشوند. اگر تاریخ داده نشود، `from_date` از تنظیم پیشفرض کتابخانه و `to_date` از تاریخ روز جلالی استفاده میکند. برای کنترل دقیق backfill همیشه هر دو تاریخ را صریح ارسال کنید.
|
|
64
|
+
|
|
65
|
+
## نصب
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
python3 -m venv .venv
|
|
69
|
+
. .venv/bin/activate
|
|
70
|
+
python -m pip install --upgrade pip
|
|
71
|
+
python -m pip install .
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
برای قابلیتهای async:
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
python -m pip install '.[async]'
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## استفادهٔ سریع
|
|
81
|
+
|
|
82
|
+
```python
|
|
83
|
+
import alilnvest_codal as cp
|
|
84
|
+
|
|
85
|
+
income = cp.income_statement("توسن")
|
|
86
|
+
balance = cp.balance_sheet("توسن")
|
|
87
|
+
cashflow = cp.cash_flow_statement("توسن")
|
|
88
|
+
letters = cp.search_letters("توسن", max_pages=1)
|
|
89
|
+
snapshot = cp.financial_snapshot("توسن")
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## خطاهای ساختاریافته
|
|
93
|
+
|
|
94
|
+
```python
|
|
95
|
+
try:
|
|
96
|
+
reports = cp.income_statement("نماد_نامعتبر")
|
|
97
|
+
except cp.SymbolNotFoundError as exc:
|
|
98
|
+
print(exc.symbol)
|
|
99
|
+
except cp.RateLimitError as exc:
|
|
100
|
+
print(exc.retry_after)
|
|
101
|
+
except cp.NetworkError as exc:
|
|
102
|
+
print(exc.status_code)
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## نرخ درخواست، retry و circuit breaker
|
|
106
|
+
|
|
107
|
+
```python
|
|
108
|
+
import alilnvest_codal as cp
|
|
109
|
+
|
|
110
|
+
cp.configure(
|
|
111
|
+
min_delay=2.0,
|
|
112
|
+
max_delay=3.5,
|
|
113
|
+
max_retries=2,
|
|
114
|
+
symbol_min_delay=15,
|
|
115
|
+
symbol_max_delay=20,
|
|
116
|
+
)
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
کتابخانه پاسخ `Retry-After` را رعایت میکند، خطاهای موقت را با backoff کنترل میکند و در شرایط شکست پیاپی circuit breaker دارد. هیچ نرخ ثابتی مسدودنشدن IP را تضمین نمیکند؛ برای چند پردازه یا چند سرویس روی یک IP از صف مرکزی استفاده کنید.
|
|
120
|
+
|
|
121
|
+
## کش و تنظیمات پیشنهادی
|
|
122
|
+
|
|
123
|
+
```env
|
|
124
|
+
CODAL_CACHE_DIR=~/bourse_reports/codal_cache
|
|
125
|
+
CODAL_FROM_JDATE=1403/01/01
|
|
126
|
+
CODAL_TO_JDATE=1405/12/29
|
|
127
|
+
CODAL_TIMEOUT=45
|
|
128
|
+
CODAL_MAX_RETRIES=3
|
|
129
|
+
CODAL_LOG_LEVEL=INFO
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
کتابخانه قبل از شبکه cache را بررسی میکند و در صورت شکست، تاریخچهٔ سالم را با دادهٔ ناقص جایگزین نمیکند.
|
|
133
|
+
|
|
134
|
+
## اتصال به کانالهای Alilnvest
|
|
135
|
+
|
|
136
|
+
کتابخانه توکن پیامرسان را داخل کد قرار نمیدهد. ارسال پیام باید در adapter برنامه انجام شود و secrets فقط در `.env` خصوصی باشند.
|
|
137
|
+
|
|
138
|
+
### کانال بله
|
|
139
|
+
|
|
140
|
+
```env
|
|
141
|
+
ALILNVEST_CHANNEL_NAME=Alilnvest
|
|
142
|
+
BALE_BOT_TOKEN=توکن_ربات_بله
|
|
143
|
+
BALE_CHANNEL_ID=@شناسه_کانال_بله
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
ربات باید در کانال بلهٔ **Alilnvest** عضو و دارای مجوز ارسال باشد.
|
|
147
|
+
|
|
148
|
+
### کانال تلگرام
|
|
149
|
+
|
|
150
|
+
```env
|
|
151
|
+
ALILNVEST_CHANNEL_NAME=Alilnvest
|
|
152
|
+
TELEGRAM_BOT_TOKEN=توکن_ربات_تلگرام
|
|
153
|
+
TELEGRAM_CHANNEL_ID=@شناسه_کانال_تلگرام
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
ربات باید در کانال تلگرام **Alilnvest** ادمین باشد. نام رسمی برند و کانالها در کپشنها، گزارشها و watermarkها نیز باید `Alilnvest` باشد.
|
|
157
|
+
|
|
158
|
+
## ساختار انتشار
|
|
159
|
+
|
|
160
|
+
- `src/alilnvest_codal/`: implementation سازگار با پروژههای قبلی
|
|
161
|
+
- `src/alilnvest_codal/`: namespace جدید برندشده
|
|
162
|
+
- `README.md`: راهنمای اصلی
|
|
163
|
+
- `MIGRATION.md`: راهنمای سازگاری
|
|
164
|
+
- `CHANGELOG.md`: تاریخچهٔ نسخه
|
|
165
|
+
- `NOTICE.md`: مالکیت و قواعد برند
|
|
166
|
+
- `LICENSE`: مجوز استفاده
|
|
167
|
+
|
|
168
|
+
فایلهای تست، fixture، probe، diagnose و اسکریپتهای توسعه از بستهٔ انتشار حذف شدهاند. تستها باید در مخزن توسعهٔ خصوصی نگهداری شوند، نه در archive تولیدی.
|
|
169
|
+
|
|
170
|
+
## دربارهٔ کپیبرداری
|
|
171
|
+
|
|
172
|
+
کدی که در GitHub عمومی قرار میگیرد از نظر فنی قابل مشاهده و قابل کپی است. هیچ obfuscation واقعی این موضوع را حل نمیکند و obfuscation دیباگ، امنیت و نگهداری را ضعیف میکند. این بسته بهجای آن versioning، metadata، `NOTICE.md` و برند مشخص دارد. اگر مالکیت انحصاری لازم است، repository را private نگه دارید و قبل از تغییر MIT به مجوز source-available محدودکننده، بررسی حقوقی انجام دهید.
|
|
173
|
+
|
|
174
|
+
## هشدار استفاده
|
|
175
|
+
|
|
176
|
+
این پروژه ابزار دریافت و پردازش داده است، نه توصیهٔ سرمایهگذاری. کیفیت و دسترسپذیری Codal ممکن است تغییر کند. قبل از استفادهٔ تولیدی، rate limit، مجوز دسترسی، cache و قوانین داده را در محیط خود بررسی کنید.
|
|
177
|
+
|
|
178
|
+
## برند رسمی
|
|
179
|
+
|
|
180
|
+
- نام محصول: **Alilnvest-Codal**
|
|
181
|
+
- نام کانالها: **Alilnvest**
|
|
182
|
+
- نام خروجی: **Alilnvest Codal Report**
|
|
183
|
+
- نام پیشنهادی کپشن: **Alilnvest Market Intelligence**
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
NOTICE.md
|
|
2
|
+
README.md
|
|
3
|
+
codal13_fixed_1.5.4-LICENSE
|
|
4
|
+
pyproject.toml
|
|
5
|
+
src/Alilnvest_Codal.egg-info/PKG-INFO
|
|
6
|
+
src/Alilnvest_Codal.egg-info/SOURCES.txt
|
|
7
|
+
src/Alilnvest_Codal.egg-info/dependency_links.txt
|
|
8
|
+
src/Alilnvest_Codal.egg-info/requires.txt
|
|
9
|
+
src/Alilnvest_Codal.egg-info/top_level.txt
|
|
10
|
+
src/alilnvest_codal/__init__.py
|
|
11
|
+
src/alilnvest_codal/_version.py
|
|
12
|
+
src/alilnvest_codal/amendments.py
|
|
13
|
+
src/alilnvest_codal/analytics.py
|
|
14
|
+
src/alilnvest_codal/api.py
|
|
15
|
+
src/alilnvest_codal/audit.py
|
|
16
|
+
src/alilnvest_codal/automation.py
|
|
17
|
+
src/alilnvest_codal/cache.py
|
|
18
|
+
src/alilnvest_codal/checks.py
|
|
19
|
+
src/alilnvest_codal/codal.py
|
|
20
|
+
src/alilnvest_codal/config.py
|
|
21
|
+
src/alilnvest_codal/datasource.py
|
|
22
|
+
src/alilnvest_codal/endpoints.py
|
|
23
|
+
src/alilnvest_codal/excel.py
|
|
24
|
+
src/alilnvest_codal/exceptions.py
|
|
25
|
+
src/alilnvest_codal/formulas.py
|
|
26
|
+
src/alilnvest_codal/frames.py
|
|
27
|
+
src/alilnvest_codal/health.py
|
|
28
|
+
src/alilnvest_codal/http.py
|
|
29
|
+
src/alilnvest_codal/letter_codes.py
|
|
30
|
+
src/alilnvest_codal/models.py
|
|
31
|
+
src/alilnvest_codal/parsers.py
|
|
32
|
+
src/alilnvest_codal/progress.py
|
|
33
|
+
src/alilnvest_codal/py.typed
|
|
34
|
+
src/alilnvest_codal/reports.py
|
|
35
|
+
src/alilnvest_codal/search.py
|
|
36
|
+
src/alilnvest_codal/sheets.py
|
|
37
|
+
src/alilnvest_codal/store.py
|
|
38
|
+
src/alilnvest_codal/utils.py
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
alilnvest_codal
|