Metadata-Version: 2.4
Name: getKST
Version: 1.1.0
Summary: A Python package that returns datetime values ​​for the Asia/Seoul region.
Author: HaeengIn
Author-email: HaeengIn <haeengin@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Dist: tzdata>=2026.4 ; sys_platform == 'win32'
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# getKST

A Python package that returns datetime values ​​for the Asia/Seoul region.

[![PyPI version](https://img.shields.io/pypi/v/getKST.svg)](https://pypi.org/project/getKST/)
[![Python versions](https://img.shields.io/pypi/pyversions/getKST.svg)](https://pypi.org/project/getKST/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Installation

### Prerequisites

- Python (>=3.9)

### Install via pip

```bash
pip install getKST
```

### Install via  uv

```bash
uv add getKST
```

## Usage

Note: Default format of **getKST** is `%Y-%m-%d %H:%M:%S` as a string.

`getKST()` always converts to Asia/Seoul time internally before formatting, so the result is identical no matter what timezone the host machine or server is set to (UTC, EST, JST, etc.).

- Basic Usage

    ```python
    from getKST import getKST

    now = getKST()
    print(now)
    ```

- Using other formats

    ```python
    from getKST import getKST

    now = getKST("%Y/%m/%d")  # Year/Month/Date
    now = getKST("%H-%M-%S")  # Hour-Minute-Second
    ```

- Converting an existing datetime

    ```python
    from datetime import datetime, timezone
    from getKST import getKST

    utc_now = datetime.now(tz=timezone.utc)
    print(getKST(dt=utc_now))
    ```

All Python datetime formats are supported.

## Change Log

### v1.1.0

- Added `KSTString` class that extends `str`, allowing the result of `getKST()` to be used as both a formatted string and a `datetime` object
- Added `KSTString.toDatetime()` method to retrieve the underlying KST `datetime` object
- Changed return type of `getKST()` from `str` to `KSTString`

### v1.0.2

- Added `tzdata` as a requirement on Windows
- Added `Change Log` section at [README.md](./README.md)

### v1.0.1

- Updated [README.md](./README.md)

### v1.0.0

- Published a package

## License

[MIT](./LICENSE)
