eddmpython commited on
Commit
8212190
·
verified ·
1 Parent(s): fabd0c5

replace code examples with intro blog + demo video + GitHub links

Browse files
Files changed (1) hide show
  1. README.md +13 -33
README.md CHANGED
@@ -34,6 +34,7 @@ size_categories:
34
  <h3>DartLab Data</h3>
35
 
36
  <p><b>Structured company data from DART & EDGAR disclosure filings</b></p>
 
37
 
38
  <p>
39
  <a href="https://github.com/eddmpython/dartlab"><img src="https://img.shields.io/badge/GitHub-dartlab-ea4647?style=for-the-badge&labelColor=050811&logo=github&logoColor=white" alt="GitHub"></a>
@@ -50,6 +51,8 @@ size_categories:
50
 
51
  Pre-collected [Parquet](https://parquet.apache.org/) files from [DartLab](https://github.com/eddmpython/dartlab) — a Python library that turns DART (Korea) and EDGAR (US) disclosure filings into one structured company map.
52
 
 
 
53
  This dataset is the **data layer** behind DartLab. When you run `dartlab.Company("005930")`, the library automatically downloads the relevant parquet from this repo.
54
 
55
  ## Dataset Structure
@@ -113,47 +116,24 @@ XBRL-based financial data from DART OpenAPI (`fnlttSinglAcntAll`).
113
 
114
  **28 API types:** dividend, employee, executive, majorHolder, treasuryStock, capitalChange, auditOpinion, stockTotal, outsideDirector, corporateBond, and more.
115
 
116
- ## Usage
117
 
118
  <img align="right" src="https://huggingface.co/datasets/eddmpython/dartlab-data/resolve/main/assets/avatar-analyze.png" width="120">
119
 
120
- ### With DartLab (recommended)
121
-
122
- ```bash
123
- pip install dartlab
124
- ```
125
-
126
- ```python
127
- import dartlab
128
-
129
- c = dartlab.Company("005930") # Samsung Electronics
130
- c.sections # full company map (topic x period)
131
- c.BS # balance sheet
132
- c.ratios # financial ratios
133
- c.show("businessOverview") # narrative text
134
 
135
- # US companies work the same way
136
- us = dartlab.Company("AAPL")
137
- us.BS
138
- us.ratios
139
- ```
140
-
141
- DartLab auto-downloads from this dataset. No manual download needed.
142
 
143
- ### Direct download
144
 
145
- ```python
146
- import polars as pl
147
 
148
- # Single file
149
- url = "https://huggingface.co/datasets/eddmpython/dartlab-data/resolve/main/dart/finance/005930.parquet"
150
- df = pl.read_parquet(url)
151
- ```
152
 
153
- ```bash
154
- # wget
155
- wget https://huggingface.co/datasets/eddmpython/dartlab-data/resolve/main/dart/finance/005930.parquet
156
- ```
157
 
158
  <img align="right" src="https://huggingface.co/datasets/eddmpython/dartlab-data/resolve/main/assets/avatar-discover.png" width="120">
159
 
 
34
  <h3>DartLab Data</h3>
35
 
36
  <p><b>Structured company data from DART & EDGAR disclosure filings</b></p>
37
+ <p>DART 전자공시 + EDGAR 공시 데이터 — 한국 2,700사 / 미국 970사</p>
38
 
39
  <p>
40
  <a href="https://github.com/eddmpython/dartlab"><img src="https://img.shields.io/badge/GitHub-dartlab-ea4647?style=for-the-badge&labelColor=050811&logo=github&logoColor=white" alt="GitHub"></a>
 
51
 
52
  Pre-collected [Parquet](https://parquet.apache.org/) files from [DartLab](https://github.com/eddmpython/dartlab) — a Python library that turns DART (Korea) and EDGAR (US) disclosure filings into one structured company map.
53
 
54
+ 한국 DART 전자공시 시스템과 미국 SEC EDGAR에서 수집한 기업 공시 데이터입니다.
55
+
56
  This dataset is the **data layer** behind DartLab. When you run `dartlab.Company("005930")`, the library automatically downloads the relevant parquet from this repo.
57
 
58
  ## Dataset Structure
 
116
 
117
  **28 API types:** dividend, employee, executive, majorHolder, treasuryStock, capitalChange, auditOpinion, stockTotal, outsideDirector, corporateBond, and more.
118
 
119
+ ## Learn More
120
 
121
  <img align="right" src="https://huggingface.co/datasets/eddmpython/dartlab-data/resolve/main/assets/avatar-analyze.png" width="120">
122
 
123
+ DartLab auto-downloads from this dataset — one stock code gives you the full company map. Start with the intro below.
 
 
 
 
 
 
 
 
 
 
 
 
 
124
 
125
+ <div align="center">
 
 
 
 
 
 
126
 
127
+ <a href="https://www.youtube.com/shorts/97lYLWMWzvA"><img src="https://img.youtube.com/vi/97lYLWMWzvA/maxresdefault.jpg" alt="DartLab 30s Demo" width="320"></a>
128
 
129
+ <sub>▶ <a href="https://www.youtube.com/shorts/97lYLWMWzvA">DartLab 30s Demo</a></sub>
 
130
 
131
+ </div>
 
 
 
132
 
133
+ - **GitHub** — [github.com/eddmpython/dartlab](https://github.com/eddmpython/dartlab)
134
+ - **Intro blog** — [DartLab 시작하기 / Getting started](https://eddmpython.github.io/dartlab/blog/dartlab-easy-start)
135
+ - **Docs** — [eddmpython.github.io/dartlab](https://eddmpython.github.io/dartlab/)
136
+ - **YouTube** — [@eddmpython](https://www.youtube.com/@eddmpython)
137
 
138
  <img align="right" src="https://huggingface.co/datasets/eddmpython/dartlab-data/resolve/main/assets/avatar-discover.png" width="120">
139