Metadata-Version: 2.4
Name: ncloud-mlx-sdk
Version: 0.1.1
Summary: SDK for the ML expert Platform on NAVER Cloud Platform
Project-URL: Homepage, https://guide.ncloud-docs.com/docs/ai-mlxp-overview
Project-URL: Documentation, https://guide.ncloud-docs.com/docs/ai-mlxp-overview
Author-email: navercloud-mlxp <dl_mlx_ncp_dev@navercorp.com>
License-Expression: Apache-2.0
License-File: LICENSE
Requires-Python: <4.0.0,>=3.9.0
Requires-Dist: aiofiles<24,>=23.2.1
Requires-Dist: google-auth-oauthlib<2,>=1.2.0
Requires-Dist: httpx<0.28,>=0.27.0
Requires-Dist: kubeconfig<2,>=1.1.1
Requires-Dist: kubernetes<28,>=27.2.0
Requires-Dist: pydantic<3,>=2.7.4
Requires-Dist: pyjwt<3,>=2.8.0
Requires-Dist: python-dateutil<3,>=2.9.0.post0
Requires-Dist: pyyaml<7,>=6.0.1
Requires-Dist: requests<3,>=2.32.3
Requires-Dist: six<2,>=1.16.0
Requires-Dist: timeago<2,>=1.0.16
Requires-Dist: typing==3.7.4.3
Requires-Dist: yamlpath<4,>=3.8.2
Description-Content-Type: text/markdown

# ML expert Platform SDK

Python ML expert Platform CLI 제품군을 구현하기 위한 공통 SDK 를 제공합니다.

## 사용 방법

### API Key 설정

ML expert Platform SDK를 사용하기 전에 API Key를 설정해야 합니다. 다음 3가지 방법 중 하나를 선택하세요:

#### 1. 환경변수로 설정
```bash
export MLX_APIKEY="your-api-key"
export MLX_ENDPOINT_URL="https://your-api-server.com"
```

#### 2. CLI 명령어로 설정
```bash
mlx configure
```

#### 3. 코드에서 직접 설정
```python
from mlx.sdk.core.config import ConfigFile

config = ConfigFile()
config.apikey = "your-api-key"
config.endpoint_url = "https://your-api-server.com"
```

### 기본 사용법

```python
from mlx.sdk.core.base import api_client, BaseMLXWebappAPI

# Method 1: API key를 직접 전달
client = api_client(
    mlx_webapp_endpoint="https://your-api-server.com",
    api_key="your-api-key",
    api_cls=BaseMLXWebappAPI
)

# Method 2: 환경변수나 config에서 자동 로드
client = api_client(
    mlx_webapp_endpoint="https://your-api-server.com",
    api_cls=BaseMLXWebappAPI
)
```

## 개발 환경 구성

### 1. uv 설치

[설치 가이드](https://docs.astral.sh/uv/getting-started/installation/) 참고.

pip 를 통해서도 설치 가능합니다.

```bash
pip install uv
```

### 2. build

```bash
make lock
make build
```

### 3. 단위 테스트 실행

```bash
make test
```
