A package to create header images using Ideogram API
Project description
title: Header Creator emoji: 🦀 colorFrom: purple colorTo: yellow sdk: streamlit sdk_version: 1.39.0 app_file: app.py pinned: false license: mit
Header Creator
Header Creator は、Ideogram API を使用してヘッダー画像を生成し、処理するための Python パッケージです。バージョン 0.2.0 がリリースされました。
🚀 プロジェクト概要
Header Creatorは、Ideogram APIを用いてヘッダー画像を生成するPythonパッケージです。コマンドラインインターフェース(CLI)とStreamlitアプリの両方から利用可能です。 バージョン 0.2.0では、Streamlitアプリによるユーザーインターフェースが追加されました。
✨ 主な機能
- Ideogram API を使用したヘッダー画像生成
- コマンドラインインターフェース (CLI) とStreamlitアプリからの利用
- 設定ファイル(
config.py
)によるカスタマイズ - StreamlitアプリによるAPIキー管理、プロンプト入力、マスク画像アップロード、パラメータ設定
🔧 使用方法
Streamlitアプリを使用することで、GUIから簡単にヘッダー画像を生成できます。詳細はStreamlitアプリをご確認ください。
Python スクリプトから使用する場合
from header_creator import create_header
result = create_header(
prompt="A stunning tropical paradise header image",
input_image_path="path/to/input.png",
mask_image_path="path/to/mask.png",
output_image_path="path/to/output.png",
api_key="YOUR_API_KEY" # または環境変数 IDEOGRAM_API_KEY
)
if result:
print(f"ヘッダー画像が生成されました: {result}")
else:
print("ヘッダー画像の生成に失敗しました")
コマンドラインから使用する場合
header-creator --prompt "A stunning tropical paradise header image" --input path/to/input.png --mask path/to/mask.png --output path/to/output.png --api-key YOUR_API_KEY # または環境変数 IDEOGRAM_API_KEY
📦 インストール手順
- PyPI からインストールします:
pip install header-creator
.env
ファイルを作成し、IDEOGRAM_API_KEY
にIdeogram APIキーを設定します (.env.example
を参照)。
⚙️ 設定
config.py
ファイルで以下のデフォルト設定を変更できます:
DEFAULT_MODEL
: 使用する Ideogram モデル (デフォルト:V_2_TURBO
)DEFAULT_MAGIC_PROMPT
: マジックプロンプトオプション (デフォルト:ON
)DEFAULT_ASPECT_RATIO
: 生成する画像のアスペクト比 (デフォルト:ASPECT_16_9
)DEFAULT_STYLE_TYPE
: 生成する画像のスタイルタイプ (デフォルト:RENDER_3D
)
📄 ライセンス
このプロジェクトは MIT ライセンスの下で公開されています。詳細は LICENSE ファイルを参照してください。
🤝 貢献
バグ報告、機能リクエスト、プルリクエストを歓迎します。大きな変更を加える前に、まずイシューを開いて変更内容について議論してください。
🙏 謝辞
このプロジェクトは Ideogram API を使用しています。 iris-s-coon さんと Maki さんに感謝します。
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file header_creator-0.2.1.tar.gz
.
File metadata
- Download URL: header_creator-0.2.1.tar.gz
- Upload date:
- Size: 6.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0adba1b47008deee36653078fe6fb5bf319da425b1945aa6decbdf20bb766694 |
|
MD5 | d5552d25468333d531495ae9e4235961 |
|
BLAKE2b-256 | 35a29ba5c15a4552e7d01420c575c40c787c83b3ed0d623fa9e645ddd37b0646 |
File details
Details for the file header_creator-0.2.1-py3-none-any.whl
.
File metadata
- Download URL: header_creator-0.2.1-py3-none-any.whl
- Upload date:
- Size: 8.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d4c0adf171e189dad3502ad58a1e1324c032737d2f617284240e7d894eb7315 |
|
MD5 | 5e099ddf446eb2f89078a9e33cddbd09 |
|
BLAKE2b-256 | 9c6c07375b752cdfd515cc8b3453f20cbcd64248022db5fdc0b84fb3a142b894 |