File size: 5,931 Bytes
2d5428b
 
 
 
 
 
 
 
 
 
 
5ba92b5
 
9100260
2b5ca13
5ba92b5
 
 
 
 
e86491e
 
 
5ba92b5
 
 
 
 
 
 
8bb7cc6
2b5ca13
ea70d43
2b5ca13
8bb7cc6
2b5ca13
ea70d43
2b5ca13
ea70d43
 
9100260
b5b8e49
8bb7cc6
2b5ca13
 
8bb7cc6
 
b5b8e49
 
 
 
8bb7cc6
b5b8e49
 
 
 
 
9100260
ea70d43
 
 
 
 
 
 
 
2b5ca13
b5b8e49
 
9100260
8bb7cc6
 
 
9100260
 
 
 
2b5ca13
8bb7cc6
b5b8e49
 
 
 
8bb7cc6
b5b8e49
 
 
 
 
8bb7cc6
b5b8e49
 
 
7c5f02c
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2b5ca13
8bb7cc6
 
 
 
 
 
 
 
 
 
 
 
 
2b5ca13
5ba92b5
2b5ca13
7c5f02c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
---
license: mit
title: pic-to-header
sdk: streamlit
emoji: 🐨
colorFrom: blue
colorTo: purple
pinned: false
app_file: pic_to_header/app.py
---

<div align="center">

# Pic-to-Header

![Pic-to-Header Result](https://raw.githubusercontent.com/Sunwood-ai-labs/pic-to-header/refs/heads/main/assets/result.png)

[![GitHub license](https://img.shields.io/github/license/Sunwood-ai-labs/pic-to-header)](https://github.com/Sunwood-ai-labs/pic-to-header/blob/main/LICENSE)
[![GitHub stars](https://img.shields.io/github/stars/Sunwood-ai-labs/pic-to-header)](https://github.com/Sunwood-ai-labs/pic-to-header/stargazers)
[![GitHub issues](https://img.shields.io/github/issues/Sunwood-ai-labs/pic-to-header)](https://github.com/Sunwood-ai-labs/pic-to-header/issues)
[![GitHub release](https://img.shields.io/github/release/Sunwood-ai-labs/pic-to-header.svg)](https://GitHub.com/Sunwood-ai-labs/pic-to-header/releases/)
[![GitHub tag](https://img.shields.io/github/tag/Sunwood-ai-labs/pic-to-header.svg)](https://GitHub.com/Sunwood-ai-labs/pic-to-header/tags/)
[![PyPI version](https://badge.fury.io/py/pic-to-header.svg)](https://badge.fury.io/py/pic-to-header)

![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
![Streamlit](https://img.shields.io/badge/Streamlit-FF4B4B?style=for-the-badge&logo=Streamlit&logoColor=white)
![OpenCV](https://img.shields.io/badge/opencv-%23white.svg?style=for-the-badge&logo=opencv&logoColor=white)

</div>

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

## 🚀 プロジェクト概要

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

## ✨ 主な機能

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


## 🔧 使用方法

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

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

```bash
pip install pic-to-header
```

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

1. リポジトリをクローンします:
   ```bash
   git clone https://github.com/Sunwood-ai-labs/pic-to-header.git
   cd pic-to-header
   ```
2. 必要な依存関係をインストールします:
   ```bash
   pip install -r requirements.txt
   ```

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

1. Streamlitアプリケーションを起動します:
   ```bash
   streamlit run pic_to_header/app.py
   ```
2. ブラウザで表示されるURLにアクセスします。
3. 入力画像とマスク画像をアップロードします。
4. "ヘッダー画像を生成"ボタンをクリックします。
5. 生成されたヘッダー画像をプレビューし、必要に応じてダウンロードします。


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

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

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

例:

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

### Pythonスクリプトでの使用

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

```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](LICENSE)ファイルを参照してください。