> ## Documentation Index
> Fetch the complete documentation index at: https://hangulpy.uiharu.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# 소개

> hangulpy 소개

`hangulpy`는 한글 처리에 필요한 공개 API를 한 곳에 모은 Python 라이브러리입니다. 초성 검색, 조사 선택, 자모 분해와 조합, 숫자 읽기, 로마자 표기, 키보드 오타 보정까지 파이썬 코드에서 바로 사용할 수 있습니다.

## 무엇을 할 수 있나

* 초성 추출과 초성 검색
* 부분 음절 검색과 패턴 매칭
* 조사 자동 선택
* 한글 여부 검사와 초중종성 추출
* 자모 분해, 자모 조합, 음절 생성
* 숫자와 한글 변환
* 로마자 표기 변환
* 한영 키보드 입력 교정
* 가나다 순 정렬

## 문서 구성

* [설치하기](/installation)
* [빠른 시작](/quickstart)
* [API 개요](/api/overview)
* [전체 공개 함수 목록](/implemented-features)

## 빠른 예시

```python theme={null}
from hangulpy import (
    HangulSearcher,
    get_hangul_components,
    join_jamos,
    josa,
    romanize,
)

print(josa("사과", "을/를"))  # 사과를

searcher = HangulSearcher("ㄹㅁ")
print(searcher.search("라면"))  # True

print(get_hangul_components("한"))  # ('ㅎ', 'ㅏ', 'ㄴ')
print(join_jamos(["ㅎ", "ㅏ", "ㄴ", "ㄱ", "ㅡ", "ㄹ"]))  # 한글
print(romanize("한글", "revised"))  # hangeul
```

## 문서를 읽는 순서

* 처음 쓰는 경우: [설치하기](/installation), [빠른 시작](/quickstart) 순서로 보면 됩니다.
* 특정 함수가 필요한 경우: [API 개요](/api/overview)에서 원하는 API 페이지로 이동하면 됩니다.
* 전체 범위를 한 번에 보고 싶은 경우: [전체 공개 함수 목록](/implemented-features)

## 기준

이 문서는 `hangulpy/__init__.py` 에서 공개하는 API를 기준으로 정리합니다. 내부 구현은 변경될 수 있지만, 여기서 설명하는 이름은 사용자 기준 진입점입니다.