Metadata-Version: 2.1
Name: python-solapi-messages
Version: 0.1.0
Summary: A Python library for sending messages using SolApi
Home-page: https://github.com/RUNNERS-IM/python-solapi-messages
Author: RUNNERS
Author-email: dev@runners.im
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.25.1

# SolApi SMS Python Library

SolApi SMS는 SolApi 서비스를 사용하여 SMS, LMS, MMS 메시지를 쉽게 전송할 수 있게 해주는 Python 라이브러리입니다. 이 라이브러리는 메시지의 길이나 이미지 파일의 유무에 따라 자동으로 적절한 메시지 유형을 선택할 수 있습니다.

## 주요 기능

- SMS, LMS, MMS 메시지 전송
- 단일 및 대량 메시지 전송
- 예약 발송
- 메시지 길이에 따른 자동 유형 전환
- 이미지 파일이 존재할 경우 MMS로 자동 전환
- 간편한 설정 및 사용

## 설치

pip를 사용하여 라이브러리를 설치할 수 있습니다:

```bash
pip install solapi-sms
```

## 기본 사용 예시

```python
from solapi.config import SolApiConfig
from solapi.sms.message import MessageSender

# 설정
config = SolApiConfig(api_key="YOUR_API_KEY", secret_key="YOUR_SECRET_KEY")
sender = MessageSender(config)

# SMS 또는 LMS 전송 (메시지 길이에 따라 자동 전환)
message = sender.create_message("029302266", "안녕하세요, SolApi SMS 테스트입니다.")
response = sender.send_one(message, "01012345678")
print(response.json())

# MMS 전송 (이미지 파일 ID 포함 시 자동으로 MMS 전환)
message = sender.create_message("029302266", "MMS 테스트입니다.", image_id="FILE_ID")
response = sender.send_one(message, "01012345678")
print(response.json())

```

## 고급 사용 예시

### 예약 발송

```python
from datetime import datetime, timedelta
from solapi.config import SolApiConfig
from solapi.sms.message import MessageSender

# 설정
config = SolApiConfig(api_key="YOUR_API_KEY", secret_key="YOUR_SECRET_KEY")
sender = MessageSender(config)

# 24시간 후 발송
scheduled_time = datetime.now() + timedelta(hours=24)
message = sender.create_message("029302266", "예약 발송 테스트입니다.", scheduled_date=scheduled_time)
response = sender.send_one(message, "01012345678")
print(response.json())

```

### 대량 발송

```python
from solapi.config import SolApiConfig
from solapi.sms.message import MessageSender

# 설정
config = SolApiConfig(api_key="YOUR_API_KEY", secret_key="YOUR_SECRET_KEY")
sender = MessageSender(config)

message = sender.create_message("029302266", "대량 발송 테스트입니다.")
to_numbers = ["01012345678", "01087654321", "01011112222"]
response = sender.send_many(message, to_numbers)
print(response.json())

```

### LMS 발송

```python
from solapi.config import SolApiConfig
from solapi.sms.message import MessageSender

# 설정
config = SolApiConfig(api_key="YOUR_API_KEY", secret_key="YOUR_SECRET_KEY")
sender = MessageSender(config)

mms_message = sender.create_message("029302266", "MMS 본문입니다.", image_id="FILE_ID")
response = sender.send_one(mms_message, "01012345678")
print(response.json())

```

### MMS 발송

```python
from solapi.config import SolApiConfig
from solapi.sms.message import MessageSender

# 설정
config = SolApiConfig(api_key="YOUR_API_KEY", secret_key="YOUR_SECRET_KEY")
sender = MessageSender(config)

mms_message = sender.create_message("029302266", "MMS 본문입니다.", image_id="FILE_ID")
response = sender.send_one(mms_message, "01012345678")
print(response.json())

```

## 설정

`SolApiConfig` 클래스를 사용하여 API 키와 시크릿 키를 설정합니다:

```python
from solapi.config import SolApiConfig

config = SolApiConfig(
    api_key="YOUR_API_KEY",
    secret_key="YOUR_SECRET_KEY",
    domain="api.solapi.com",  # 선택적
    protocol="https",  # 선택적
    prefix=""  # 선택적
)
```

## 개발 및 테스트

프로젝트를 복제한 후, 의존성을 설치하고 테스트를 실행합니다:

```bash
git clone https://github.com/RUNNERS_IM/solapi-sms-python.git
cd solapi-sms-python
pip install -r requirements.txt
python -m unittest discover tests
```

## 라이선스

이 프로젝트는 MIT 라이선스 하에 배포됩니다. 자세한 내용은 `LICENSE` 파일을 참조하세요.
