Skip to main content

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 Logo

Header Creator

PyPI version Python versions License GitHub stars GitHub issues

Header Creator は、Ideogram API を使用してヘッダー画像を生成し、処理するための Python パッケージです。バージョン 0.2.1 がリリースされました。

Python Click Requests Loguru Ideogram pic-to-header

🚀 プロジェクト概要

Header Creatorは、Ideogram APIを用いてヘッダー画像を生成するPythonパッケージです。コマンドラインインターフェース(CLI)とStreamlitアプリの両方から利用可能です。 バージョン 0.2.1では、Streamlitアプリによるユーザーインターフェースが追加され、リポジトリ名が"HarmonAI III"から"Header Creator"に変更されました。

✨ 主な機能

  • Ideogram API を使用したヘッダー画像生成
  • コマンドラインインターフェース (CLI) とStreamlitアプリからの利用
  • 設定ファイル(config.py)によるカスタマイズ
  • StreamlitアプリによるAPIキー管理、プロンプト入力、マスク画像アップロード、パラメータ設定

🔧 使用方法

Streamlitアプリを使用することで、GUIから簡単にヘッダー画像を生成できます。app.py を実行して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

📦 インストール手順

  1. PyPI からインストールします:
pip install header-creator
  1. .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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

header_creator-0.2.2.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

header_creator-0.2.2-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file header_creator-0.2.2.tar.gz.

File metadata

  • Download URL: header_creator-0.2.2.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

Hashes for header_creator-0.2.2.tar.gz
Algorithm Hash digest
SHA256 5f193e6ead2b110777b34c2027febd6ffe6d5be76d1340338e67df7971f31e56
MD5 096c5813754269b61fc31d19d9489ac9
BLAKE2b-256 64469568cb556ef910a5d83903d03bb881af25c1a02789bb02885ca0441d6964

See more details on using hashes here.

File details

Details for the file header_creator-0.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for header_creator-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 90febdb0308c77b6880b13839fc09de8f6743a523998a41eacd3498e19682537
MD5 dbc2185d38a8ae66a2b055b74b2e3729
BLAKE2b-256 fdbfaa0b5f58232553e2477b0316217268a885c6736b2f64fde4ba52152c0317

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page