Metadata-Version: 2.1
Name: mirinae
Version: 0.1.13
Summary: Mirinae is a Python package for MAGO's framework
Home-page: https://github.com/holamago/mirinae-cli.git
Author: MAGO
Author-email: galois@holamago.com
License: MIT
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: requests
Requires-Dist: type_docopt
Requires-Dist: pydantic
Requires-Dist: pandas
Requires-Dist: matplotlib
Requires-Dist: networkx

# Mirinae

![MAGO](https://img.shields.io/badge/MAGO-INC-red)
![audion](https://img.shields.io/badge/audion-service-blue)
![python](https://img.shields.io/badge/python-3.10-green)

마고 프레임워크를 사용할 수 있는 CLI 도구입니다.

## 마고 서비스

- [audion](https://audion.magovoice.com)
- 문의: contact@holamago.com

## 설치

- Python 3.9 이상이 필요합니다.

```bash
pip install mirinae
```

- `mirinae`는 /home/user/.mirinae 디렉토리에 설정 파일을 저장합니다.
- `mirinae`를 사용하기 위해서는 `PATH` 환경 변수에 /home/user/.local/bin 디렉토리를 추가해야 합니다.

```bash
echo 'export PATH=$PATH:/home/galois/.local/bin' >> ~/.bashrc
source ~/.bashrc
```

zsh를 사용하는 경우에는 ~/.zshrc 파일을 수정해야 합니다.

```bash
echo 'export PATH=$PATH:/home/galois/.local/bin' >> ~/.zshrc
source ~/.zshrc
```

## 기본 동작 방법

### 사용자 등록

- 사용자가 mirinae-cli를 사용하여 마고 서비스를 사용하기 위해서는 사용자 등록이 필요합니다.
- 사용자 등록은 [audion home](https://audion.magovoice.com)에서 진행할 수 있습니다.

### 로그인

```bash
mirinae user login -v -e <email> -w <password>
```

## Flow

`audion`에서 제공하는 서비스는 `flow`를 사용하여 서비스를 제공합니다. `flow`는 사용자가 사용하고 싶은 서비스를 선태하고 curation을 통해 사용자 맞춤형 `flow`를 생성합니다. 그리고 한 줄의 명령어로 `flow`를 실행할 수 있습니다.

### Flow 생성

#### Product

- 마고에서는 사용자가 손쉽게 서비스를 사용할 수 있도록 기본적인 `flow`를 제공합니다.
- 기본적으로 제공되는 `flow`는 `product` 형태로 제공이 되고, 이미 마고에서 기본적으로 몇 개의 `product`를 제공하고 있습니다. 사용자가 새로운 `product`를 생성하여 마고에 등록 요청을 하면, 검토를 거쳐 마고에서 `product`를 등록해 드립니다.
- 현재 지원하고 있는 프로덕트는 다음과 같습니다.

| 프로덕트 | 프로젝트 ID |
| --- | --- |
| Subtitle Generation | audion_sg |
| Voice Separation | audion_vs |
| Music Source Separation | audion_mss |

#### Project

- `flow`를 실행하기 위해서는 `project`가 필요합니다.
- `project`는 `product`를 사용하여 생성할 수 있습니다.

```bash
mirinae project create -v --prod-id <product_id>
```

생성된 프로젝트는 아래와 같이 확인할 수 있습니다.

```bash
mirinae project get -v
```

### 미디어 파일로 프로젝트 사용하기

다음 3가지 방법으로 미디어 파일을 프로젝트에 사용할 수 있습니다.

| 입력 타입 | 설명 |
| url | URL을 사용하여 미디어 파일을 사용합니다. |
| file | 로컬에 있는 미디어 파일을 사용합니다. |
| uri | 마고 서비스에 있는 미디어 파일을 사용합니다. |

#### URL을 사용하기

```bash
mirinae pipeline proj -v --proj-id <project_id> --it url -i <url>
```

#### 로컬 파일을 사용하기

```bash
mirinae pipeline proj -v --proj-id <project_id> --it file -i <file_path>
```

#### 마고 서비스에 있는 파일을 사용하기

```bash
mirinae pipeline proj -v --proj-id <project_id> --it uri -i <uri>
```
