futarin-api
目次
貢献者ガイド(CONTRIBUTING.md)
本リポジトリにコミットする場合、CONTRIBUTING.mdを必ず確認ください
動作環境（確認済み）
- Ubuntu(WSL2)
- Docker
- macOS(x86-64,arm64)
- Docker Desktop もしくは OrbStack
動作確認
-
リポジトリのクローンと移動
git clone git@github.com:futaringoto/futarin-api.git cd futarin-api -
.envの作成touch .env echo "VOICEVOX_API_KEY=[voicevox api key]" >> .env echo "OPENAI_API_KEY=[openAI api key]" >> .envVOICEVOX_API_KEYは https://su-shiki.com/api/ から、OPENAI_API_KEYは https://platform.openai.com/docs/overview から取得します -
Dockerイメージのビルド
sudo make build -
コンテナ起動
sudo make run-dev # Detachモード sudo make run-dev-d -
localhost でドキュメントを開いてみましょう http://localhost/docs
-
コンテナの停止
sudo make stop
APIエンドポイントv1
| 詳しくは https://futaringoto.github.io/futarin-api/ を参照してください。 | メソッド | パス | 概要 |
|---|---|---|---|
| POST | /v1/raspi/ |
一連の処理全て | |
| POST | /v1/sandbox/gpt/ |
ChatGPTによる文章生成 | |
| POST | /v1/sandbox/transcript/ |
whisperによる文字起こし |
[!WARNING] 従来の
/raspi/xxx/系のエンドポイントはdeprecated(非推奨)となりました。
makeコマンドについて
本リポジトリはMakefileを採用しています。 |
Make | 実行する処理 | 元のコマンド |
|---|---|---|---|
make build |
コンテナのビルド | docker compose -f docker-compose.yml -f docker-compose.dev.yml build |
|
make run-dev |
コンテナの起動 | docker compose -f docker-compose.yml -f docker-compose.dev.yml up |
|
make run-dev-d |
コンテナの起動（デタッチ） | docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d |
|
make stop |
コンテナの停止 | docker compose down |
|
make lint |
リントの実行 | docker compose run --entrypoint "flake8" api |
|
make format |
フォーマットの実行 | docker compose run --entrypoint "black ." api |
|
make test |
テストの実行 | docker compose run --entrypoint "pytest" api |
ディレクトリ構成
- api (application - FastAPI)
- nginx (web-server)
. ├── CONTRIBUTING.md ├── LICENSE ├── Makefile ├── README.md ├── _docker │ ├── api │ │ └── Dockerfile │ └── nginx │ └── conf.d │ └── app.conf ├── api │ ├── main.py │ ├── poetry.lock │ ├── pyproject.toml │ ├── tests │ │ ├── __init__.py │ │ ├── audio1.wav │ │ └── test_v1_raspi.py │ ├── uploads │ ├── v0 │ │ ├── __init__.py │ │ ├── routers │ │ │ ├── __init__.py │ │ │ └── raspi.py │ │ ├── services │ │ │ ├── __init__.py │ │ │ ├── gpt.py │ │ │ ├── tts.py │ │ │ ├── voicevox.py │ │ │ ├── voicevox_api.py │ │ │ └── whisper.py │ │ └── utils │ │ ├── __init__.py │ │ ├── config.py │ │ └── log.py │ └── v1 │ ├── __init__.py │ ├── routers │ │ ├── __init__.py │ │ ├── raspi.py │ │ └── sandbox.py │ ├── schemas │ │ ├── __init__.py │ │ └── sandbox.py │ ├── services │ │ ├── __init__.py │ │ ├── gpt.py │ │ ├── voicevox_api.py │ │ └── whisper.py │ └── utils │ ├── __init__.py │ ├── config.py │ └── logging.py ├── docker-compose.dev.yml └── docker-compose.yml
VOICEVOX
有志のVOICEVOX APIを使用しています。
ライセンス
本リポジトリはMITライセンスです。（LICENSE参照）ただし、一部apache-2.0やLGPL v3のライブラリを採用しています。それらに関してはそちらのライセンス内容を遵守してください。