MakiAi commited on
Commit
7c5f02c
1 Parent(s): 6a54bda

✨ feat: Pythonスクリプトによる画像処理機能追加とドキュメント更新

Browse files

- README.mdにPythonスクリプトを使用した使用方法を追加しました。
- `process_header_image`関数の使用方法をステップごとに説明しました。
- `pic_to_header/core.py`, `pic_to_header/app.py`, `pic_to_header/cli.py` のファイルの存在を示す開発セクションを追加しました。
- これにより、ユーザーはPythonスクリプトを用いて、より柔軟に画像処理を行うことができるようになりました。

Files changed (1) hide show
  1. README.md +34 -1
README.md CHANGED
@@ -91,6 +91,39 @@ pic-to-header input_image.png mask_image.png output_image.png
91
  pic-to-header assets/sample.png assets/mask.png output_image.png
92
  ```
93
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
94
 
95
  ## 📦 インストール手順
96
 
@@ -108,4 +141,4 @@ pic-to-header assets/sample.png assets/mask.png output_image.png
108
 
109
  ## 📄 ライセンス
110
 
111
- このプロジェクトはMITライセンスの下で公開されています。詳細については、[LICENSE](LICENSE)ファイルを参照してください。
 
91
  pic-to-header assets/sample.png assets/mask.png output_image.png
92
  ```
93
 
94
+ ### Pythonスクリプトでの使用
95
+
96
+ `pic-to-header` パッケージは、Pythonスクリプト内で直接使用することもできます。以下は使用例です:
97
+
98
+ ```python
99
+ from pic_to_header.core import process_header_image
100
+
101
+ # 入力画像、マスク画像、出力画像のパスを指定
102
+ input_image_path = "path/to/input_image.png"
103
+ mask_image_path = "path/to/mask_image.png"
104
+ output_image_path = "path/to/output_image.png"
105
+
106
+ # ヘッダー画像を生成
107
+ result = process_header_image(input_image_path, mask_image_path, output_image_path)
108
+
109
+ print(f"ヘッダー画像が生成されました: {result}")
110
+ ```
111
+
112
+ このスクリプトは以下の手順で動作します:
113
+
114
+ 1. `pic_to_header.core` モジュールから `process_header_image` 関数をインポートします。
115
+ 2. 入力画像、マスク画像、出力画像のパスを指定します。
116
+ 3. `process_header_image` 関数を呼び出して、ヘッダー画像を生成します。
117
+ 4. 生成された画像のパスを表示します。
118
+
119
+ このスクリプトを実行すると、指定した出力パスにヘッダー画像が生成されます。
120
+
121
+ ## 💻 開発
122
+
123
+ - `pic_to_header/core.py`: 画像処理の主要な機能を含みます。
124
+ - `pic_to_header/app.py`: Streamlitを使用したWebインターフェースを提供します。
125
+ - `pic_to_header/cli.py`: コマンドラインインターフェースを提供します。
126
+
127
 
128
  ## 📦 インストール手順
129
 
 
141
 
142
  ## 📄 ライセンス
143
 
144
+ このプロジェクトはMITライセンスの下で公開されています。詳細については、[LICENSE](LICENSE)ファイルを参照してください。