Metadata-Version: 2.4
Name: helper-hwp
Version: 0.5.1
Summary: Python HWP 파일 파서 및 텍스트 추출 라이브러리
Author-email: c0z0c <c0z0c.dev@gmail.com>
License: Apache-2.0
Project-URL: Homepage, https://github.com/c0z0c/helper_hwp
Project-URL: Repository, https://github.com/c0z0c/helper_hwp
Project-URL: Issues, https://github.com/c0z0c/helper_hwp/issues
Keywords: hwp,hancom,hangul,parser,text-extraction
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: olefile>=0.46
Requires-Dist: pycryptodome>=3.15.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: black>=23.0.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Requires-Dist: mypy>=1.0.0; extra == "dev"
Dynamic: license-file

# helper_hwp

Python으로 작성된 HWP (한글 문서) 파일 파서 및 텍스트 추출 라이브러리입니다.

## 특징

- HWP 5.x 포맷 지원 (CFB 기반)
- 텍스트 추출 및 마크다운 변환
- 표, 페이지 단위 파싱 지원
- 단위 변환 유틸리티 제공 (HWPUNIT ↔ cm/inch/px)

## 설치

```bash
pip install helper-hwp
```

또는 소스에서 설치:

```bash
git clone https://github.com/c0z0c/helper_hwp.git
cd helper_hwp
pip install -e .
```

## 빠른 시작

### 텍스트 추출

```python
from helper_hwp import hwp_to_txt

# HWP 파일에서 텍스트 추출
text = hwp_to_txt('example.hwp')
print(text)
```

### 마크다운 변환

```python
from helper_hwp import hwp_to_markdown

# HWP 파일을 마크다운으로 변환
markdown = hwp_to_markdown('example.hwp')
print(markdown)
```

### 문서 객체 사용

```python
from helper_hwp import open_hwp

# HWP 문서 열기
doc = open_hwp('example.hwp')

# 문단 단위 순회
for paragraph in doc.iter_paragraphs():
    print(paragraph.text)

# 표 단위 순회
for table in doc.iter_tables():
    print(table.rows)
```

## 사용 예제

더 많은 예제는 [examples](examples/) 디렉토리를 참조하세요:

- [텍스트 추출 예제](examples/example_hwp_to_txt.py)
- [마크다운 변환 예제](examples/example_hwp_to_markdown.py)
- [태그 순회 예제](examples/example_iter_tags.py)

## 문서

- [사용자 가이드](docs/USER_GUIDE.md) - 기본 사용법 및 예제
- [개발자 문서](docs/DEVELOPER.md) - 프로젝트 구조 및 개발 가이드

## 요구사항

- Python 3.8 이상
- olefile >= 0.46
- pycryptodome >= 3.15.0

## 라이센스

이 프로젝트는 Apache License 2.0 라이센스 하에 배포됩니다.

누구나 자유롭게 사용하고 수정할 수 있으며, 사용 시 출처를 표기해 주세요.

출처: https://github.com/c0z0c/helper_hwp

자세한 내용은 [LICENSE](LICENSE) 파일을 참조하세요.

## 기여

프로젝트에 대한 기여를 환영합니다! 기여 방법은 [개발자 문서](docs/DEVELOPER.md)를 참조하세요.

## 변경 이력

변경 이력은 [CHANGELOG.md](CHANGELOG.md)를 참조하세요.
