https://github.com/ks6088ts-labs/template-streamlit
This is a template repository for Streamlit
https://github.com/ks6088ts-labs/template-streamlit
azure-openai streamlit
Last synced: 2 months ago
JSON representation
This is a template repository for Streamlit
- Host: GitHub
- URL: https://github.com/ks6088ts-labs/template-streamlit
- Owner: ks6088ts-labs
- License: mit
- Created: 2025-05-27T05:58:41.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-23T06:20:47.000Z (about 1 year ago)
- Last Synced: 2025-06-23T07:19:43.829Z (about 1 year ago)
- Topics: azure-openai, streamlit
- Language: Python
- Homepage: https://ks6088ts-labs.github.io/template-streamlit/
- Size: 1.11 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/ks6088ts-labs/template-streamlit/actions/workflows/test.yaml?query=branch%3Amain)
[](https://github.com/ks6088ts-labs/template-streamlit/actions/workflows/docker.yaml?query=branch%3Amain)
[](https://github.com/ks6088ts-labs/template-streamlit/actions/workflows/docker-release.yaml)
[](https://github.com/ks6088ts-labs/template-streamlit/actions/workflows/ghcr-release.yaml)
[](https://github.com/ks6088ts-labs/template-streamlit/actions/workflows/github-pages.yaml)
[](https://hub.docker.com/r/ks6088ts/template-streamlit)
[](https://hub.docker.com/r/ks6088ts/template-streamlit)
[](https://hub.docker.com/r/ks6088ts/template-streamlit)
# template-streamlit
## 概要 (Overview)
`template-streamlit`は、[Streamlit](https://streamlit.io/)アプリケーションの開発に必要な基本構造とツールを提供するテンプレートリポジトリです。このテンプレートを使用することで、AI 機能を持つ Web アプリケーションを迅速に開発・デプロイすることができます。
This template repository provides the basic structure and tools needed for developing [Streamlit](https://streamlit.io/) applications. By using this template, you can quickly develop and deploy web applications with AI capabilities.
## 特徴と利点 (Features and Benefits)
### 主な特徴 (Key Features)
- **Streamlit フレームワーク**: インタラクティブな Web アプリケーションを短時間で構築
- **LangChain サポート**: AI モデル（Azure OpenAI、Ollama）との連携機能
- **Docker サポート**: コンテナベースの開発・デプロイが可能
- **テキスト分割プレイグラウンド**: 異なるテキスト分割方法の視覚化
- **環境変数管理**: API キーなどの機密情報を安全に管理
- **MkDocs 統合**: プロジェクトドキュメントの自動生成
### 利点 (Benefits)
- **開発時間の短縮**: 必要なコンポーネントが事前構成済み
- **Makefile による標準化**: 一貫した開発ワークフロー
- **コンテナ対応**: 環境依存性の問題を削減
- **モジュール構造**: 拡張や機能追加が容易
- **CI パイプライン**: ビルドとテスト自動化の設定済み
## 前提条件 (Prerequisites)
- [Python 3.10+](https://www.python.org/downloads/)
- [uv](https://docs.astral.sh/uv/getting-started/installation/)
- [GNU Make](https://www.gnu.org/software/make/)
- Docker（Docker を使用する場合）
## 開発手順 (Development Instructions)
当プロジェクトは`Makefile`を中心とした開発ワークフローを採用しています。主な操作はすべて Make コマンドから実行できます。
### ヘルプ表示 (View Help)
`Makefile`で定義されているすべてのコマンドを表示するには：
```shell
make
# または
make help
```
### ローカル開発 (Local Development)
#### 依存関係のインストール (Install Dependencies)
```shell
# 開発用依存関係をインストール
make install-deps-dev
# 本番用依存関係のみをインストール
make install-deps
```
#### コードフォーマットとリント (Code Formatting and Linting)
```shell
# コードフォーマットを適用
make format
# 自動修正を適用
make fix
# リントチェック
make lint
```
#### テスト実行 (Run Tests)
```shell
# テストを実行
make test
# CIテストを実行（フォーマットチェック、リント、テスト）
make ci-test
```
#### Streamlit アプリの実行 (Run Streamlit App)
```shell
# Streamlitアプリを起動（ポート8000）
make streamlit
```
実行後、ブラウザで http://localhost:8000 を開くと Streamlit アプリケーションにアクセスできます。
#### その他の開発ツール (Other Development Tools)
```shell
# JupyterLabを起動
make jupyterlab
# ドキュメントをローカルで表示
make docs-serve
```
### Docker 開発 (Docker Development)
Docker を使用して開発環境を構築することもできます。
```shell
# Dockerイメージをビルド
make docker-build
# Dockerコンテナを実行
make docker-run
# DockerでCIテストを実行
make ci-test-docker
```
## Docker 使用方法 (Docker Usage)
### 簡単な実行方法 (Quick Start)
Docker を使ってワンライナーでアプリを実行する：
```shell
docker run --rm -p 8000:8000 ks6088ts/template-streamlit:latest streamlit run main.py --server.port 8000 --server.address 0.0.0.0
```
### 環境変数の設定 (Environment Variables)
環境変数を使用する場合（例：Azure OpenAI API キー）：
```shell
# .envファイルをコンテナにマウント
docker run --rm \
-v $(pwd)/.env:/app/.env \
-p 8000:8000 \
ks6088ts/template-streamlit:latest
```
`.env`ファイルの例（`.env.template`をコピーして作成）：
```
AZURE_OPENAI_API_KEY=your_api_key
AZURE_OPENAI_ENDPOINT=https://your-resource.openai.azure.com/
AZURE_OPENAI_API_VERSION=2023-07-01-preview
AZURE_OPENAI_GPT_MODEL=your-gpt-deployment
```
### ポート設定 (Port Configuration)
デフォルトでポート 8000 を使用しますが、ホスト側のポートは変更可能です：
```shell
# ホスト側ポート3000をコンテナの8000にマッピング
docker run --rm \
-p 3000:8000 \
ks6088ts/template-streamlit:latest
```
この場合、ブラウザで http://localhost:3000 にアクセスします。
### トラブルシューティング (Troubleshooting)
- **コンテナが起動しない場合**: ポートが既に使用されていないか確認してください
- **環境変数が読み込まれない場合**: `.env`ファイルのパスが正しいか確認してください
- **API エラー**: `.env`ファイル内の API キーや設定を確認してください
## デプロイ手順 (Deployment Instructions)
### Docker Hub
Docker Hub にイメージを公開するには、[アクセストークンを作成](https://app.docker.com/settings/personal-access-tokens/create)し、リポジトリの設定に以下のシークレットを設定する必要があります。
```shell
gh secret set DOCKERHUB_USERNAME --body $DOCKERHUB_USERNAME
gh secret set DOCKERHUB_TOKEN --body $DOCKERHUB_TOKEN
```