1717import sys
1818import textwrap
1919from pathlib import Path
20- from typing import Optional , get_type_hints
20+ from typing import get_type_hints
2121
2222ROOT = Path (__file__ ).resolve ().parent .parent
2323sys .path .insert (0 , str (ROOT / "src" ))
@@ -256,28 +256,58 @@ def generateApiSpec() -> str:
256256def generateLlmsTxt () -> str :
257257 """llms.txt 생성 — AI 크롤러용."""
258258 lines = [
259- "# dartlab " ,
259+ "# DartLab — DART + EDGAR Disclosure Analysis Python Library " ,
260260 "" ,
261- "> DART 전자공시 데이터를 활용한 한국 상장기업 재무 분석 Python 라이브러리." ,
261+ "> Turn Korean DART and US SEC EDGAR filings into one structured company map." ,
262+ "> 한국 DART 전자공시와 미국 SEC EDGAR 공시를 하나의 회사 맵으로 바꾸는 Python 라이브러리." ,
262263 "" ,
263- "## 설치" ,
264+ "DartLab parses corporate disclosure filings — annual reports, 10-K, 10-Q — into structured," ,
265+ "comparable data. Financial statements (BS/IS/CF), 47 financial ratios, 7-area insight grades," ,
266+ "narrative text, and structured reports are all accessible with a single stock code." ,
267+ "Covers 2,700+ Korean listed companies and 970+ US companies." ,
264268 "" ,
265- "```" ,
269+ "## Install" ,
270+ "" ,
271+ "```bash" ,
266272 "pip install dartlab" ,
273+ "# or" ,
274+ "uv add dartlab" ,
267275 "```" ,
268276 "" ,
269- "## 빠른 시작 " ,
277+ "## Quick Start " ,
270278 "" ,
271279 "```python" ,
272280 "import dartlab" ,
273281 "" ,
274- 'c = dartlab.Company("005930")' ,
275- "c.index # 회사 구조 인덱스" ,
276- 'c.show("BS") # topic payload 보기' ,
277- 'c.trace("dividend") # source 추적' ,
282+ "# Korean company (DART)" ,
283+ 'c = dartlab.Company("005930") # Samsung Electronics' ,
284+ "c.index # company structure index" ,
285+ 'c.show("BS") # balance sheet' ,
286+ 'c.show("executiveCompensation") # topic payload' ,
287+ 'c.trace("dividend") # source provenance' ,
288+ "c.ratios # 47 financial ratios" ,
289+ "c.insights # 7-area A~F grades" ,
290+ "" ,
291+ "# US company (EDGAR)" ,
292+ 'us = dartlab.Company("AAPL") # Apple Inc.' ,
293+ "us.BS # balance sheet" ,
294+ "us.ratios # financial ratios" ,
295+ "us.sections # 10-K sections map" ,
278296 "```" ,
279297 "" ,
280- "## 주요 기능" ,
298+ "## Key Features" ,
299+ "" ,
300+ "- **Sections-first architecture**: Every company becomes a topic × period DataFrame" ,
301+ "- **Dual market**: DART (Korea) + EDGAR (US) with identical interface" ,
302+ "- **One stock code**: `dartlab.Company('005930')` or `dartlab.Company('AAPL')`" ,
303+ "- **Financial statements**: BS, IS, CF, CIS, SCE — XBRL-normalized, quarterly standalone" ,
304+ "- **47 financial ratios**: ROE, ROA, operating margin, debt ratio, PER, PBR, FCF, etc." ,
305+ "- **7-area insight grades**: Performance, profitability, stability, cash flow, governance, risk, opportunity" ,
306+ "- **AI analysis**: `dartlab ask '삼성전자 분석해줘'` — natural language company analysis" ,
307+ "- **MCP server**: Expose company data as MCP tools for Claude Desktop, ChatGPT, Cursor" ,
308+ "- **329 topics per company**: From dividend policy to segment breakdown" ,
309+ "" ,
310+ "## Data Modules" ,
281311 "" ,
282312 ]
283313
@@ -291,18 +321,22 @@ def generateLlmsTxt() -> str:
291321
292322 lines .extend (
293323 [
294- "## 분석 엔진 " ,
324+ "## Analysis Engines " ,
295325 "" ,
296- "- **섹터 분류**: WICS 11섹터 자동 분류 (오버라이드 → 키워드 → KSIC 3단계)" ,
297- "- **인사이트 등급**: 7영역 A~F 등급 (실적, 수익성, 건전성, 현금흐름, 지배구조, 리스크, 기회)" ,
298- "- **시장 순위**: 매출/자산/성장률 전체+섹터내 순위" ,
299- "- **재무비율**: ROE, ROA, 영업이익률, 부채비율, PER, PBR, FCF 등 자동 계산" ,
326+ "- **Sector classification**: WICS 11 sectors (override → keyword → KSIC 3-stage)" ,
327+ "- **Insight grades**: 7-area A~F grades (performance, profitability, stability, cash flow, governance, risk, opportunity)" ,
328+ "- **Market rank**: Revenue/assets/growth ranking — overall + within sector" ,
329+ "- **Financial ratios**: ROE, ROA, operating margin, debt ratio, PER, PBR, FCF — auto-calculated" ,
330+ "- **Supply chain**: Disclosed supplier/customer relationship mapping" ,
331+ "- **ESG**: ESG disclosure extraction and scoring" ,
332+ "- **Event study**: Abnormal return around disclosure dates" ,
300333 "" ,
301- "## 링크 " ,
334+ "## Links " ,
302335 "" ,
303- "- 문서 : https://eddmpython.github.io/dartlab/docs/" ,
336+ "- Documentation : https://eddmpython.github.io/dartlab/docs/" ,
304337 "- GitHub: https://github.com/eddmpython/dartlab" ,
305338 "- PyPI: https://pypi.org/project/dartlab/" ,
339+ "- Demo: https://huggingface.co/spaces/eddmpython/dartlab" ,
306340 "" ,
307341 ]
308342 )
0 commit comments