README.md

metadata

license: mit
title: pic-to-header
sdk: streamlit
emoji: 🐨
colorFrom: blue
colorTo: purple
pinned: false
app_file: pic_to_header/app.py

Pic-to-Header

Pic-to-Headerは、マスク画像と入力画像を使用してヘッダー画像を生成するPythonアプリケーションです。 バージョン 0.1.1 がリリースされました。

🚀 プロジェクト概要

Pic-to-Headerは、マスク画像と入力画像を使用して簡単にヘッダー画像を生成し、ダウンロードできるStreamlitアプリケーションです。PyPIにも公開されています。 コマンドラインインターフェース(CLI)にも対応しています。

✨ 主な機能

• マスク画像と入力画像のアップロード
• ヘッダー画像の生成
• 生成されたヘッダー画像のプレビューとダウンロード
• コマンドラインインターフェース (CLI) を使用した画像処理
• READMEページとリリースノートページのStreamlitアプリへの追加

🔧 使用方法

方法1: PyPIからのインストール

Pic-to-Headerは、PyPIで利用可能です。以下のコマンドでインストールできます：

pip install pic-to-header

方法2: ソースからのインストール

1. リポジトリをクローンします：

   git clone https://github.com/Sunwood-ai-labs/pic-to-header.git
   cd pic-to-header
   

2. 必要な依存関係をインストールします:

   pip install -r requirements.txt
   

Streamlitウェブアプリケーション

1. Streamlitアプリケーションを起動します：

   streamlit run pic_to_header/app.py
   

2. ブラウザで表示されるURLにアクセスします。
3. 入力画像とマスク画像をアップロードします。
4. "ヘッダー画像を生成"ボタンをクリックします。
5. 生成されたヘッダー画像をプレビューし、必要に応じてダウンロードします。

コマンドラインインターフェース (CLI)

CLIを使用して画像を処理することもできます：

pic-to-header input_image.png mask_image.png output_image.png

例：

pic-to-header assets/sample.png assets/mask.png output_image.png

Pythonスクリプトでの使用

pic-to-header パッケージは、Pythonスクリプト内で直接使用することもできます。以下は使用例です：

from pic_to_header.core import process_header_image

# 入力画像、マスク画像、出力画像のパスを指定
input_image_path = "path/to/input_image.png"
mask_image_path = "path/to/mask_image.png"
output_image_path = "path/to/output_image.png"

# ヘッダー画像を生成
result = process_header_image(input_image_path, mask_image_path, output_image_path)

print(f"ヘッダー画像が生成されました: {result}")

このスクリプトは以下の手順で動作します：

1. pic_to_header.core モジュールから process_header_image 関数をインポートします。
2. 入力画像、マスク画像、出力画像のパスを指定します。
3. process_header_image 関数を呼び出して、ヘッダー画像を生成します。
4. 生成された画像のパスを表示します。

このスクリプトを実行すると、指定した出力パスにヘッダー画像が生成されます。

💻 開発

• pic_to_header/core.py: 画像処理の主要な機能を含みます。
• pic_to_header/app.py: Streamlitを使用したWebインターフェースを提供します。
• pic_to_header/cli.py: コマンドラインインターフェースを提供します。

📦 インストール手順

上記「使用方法」セクションを参照してください。

🆕 最新情報

• コマンドラインインターフェース(CLI)の実装により、コマンドラインから画像処理が可能になりました。
• READMEページとリリースノートページがStreamlitアプリに追加されました。
• ドキュメントが改善され、PyPIからのインストール方法やCLIの使い方などが追加されました。
• CLIのエントリポイントがpic_to_header.app:mainからpic_to_header.cli:mainに変更されました。
• バージョン番号が0.1.0から0.1.1に更新されました。

📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています。詳細については、LICENSEファイルを参照してください。