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

Header Creator は、Ideogram API を使用してヘッダー画像を生成し、処理するための Python パッケージです。

Python Click Requests Loguru Ideogram

🚀 機能

  • Ideogram API を使用した画像生成
  • 生成された画像の処理と保存
  • コマンドラインインターフェース (CLI) のサポート

📦 インストール

  1. PyPI からインストールします:
pip install header-creator
  1. .env ファイルを作成し、Ideogram API キーを設定します:
IDEOGRAM_API_KEY=your_ideogram_api_key_here

🛠 使用方法

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"
)

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

⚙️ 設定

config.py ファイルで以下のデフォルト設定を変更できます:

  • DEFAULT_MODEL: 使用する Ideogram モデル
  • DEFAULT_MAGIC_PROMPT: マジックプロンプトオプション
  • DEFAULT_ASPECT_RATIO: 生成する画像のアスペクト比
  • DEFAULT_STYLE_TYPE: 生成する画像のスタイルタイプ

👨‍💻 開発

  1. このリポジトリをクローンします:
git clone https://github.com/Sunwood-ai-labs/header-creator.git
cd header-creator
  1. 仮想環境を作成し、アクティベートします:
python -m venv venv
source venv/bin/activate  # Linux/macOS
venv\Scripts\activate  # Windows
  1. 開発用の依存関係をインストールします:
pip install -r requirements.txt
  1. テストを実行します:
pytest

📄 ライセンス

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

🤝 貢献

バグ報告、機能リクエスト、プルリクエストを歓迎します。大きな変更を加える前に、まずイシューを開いて変更内容について議論してください。

🙏 謝辞

このプロジェクトは Ideogram API を使用しています。

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.1.0.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

header_creator-0.1.0-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: header_creator-0.1.0.tar.gz
  • Upload date:
  • Size: 5.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.1.0.tar.gz
Algorithm Hash digest
SHA256 fdf100963101aaa41248ae8a8a29b0cd8efd230b39529ca40e8abdae296c23c4
MD5 1d7d33d480eb967dc8a6af0b51ce599b
BLAKE2b-256 4a1831df323a84e4d86ffe079edb2e88c7bffbf7a84f98d8b8270774dd972dbf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for header_creator-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fc47f3b5cb2bf6f1ac0ca2416c76d7807ad5052bbaa4bb978cbbfa4b5df03cb7
MD5 4b85dfa991cce6b7e8ede1c9f69b8756
BLAKE2b-256 982dc98ee809a1a24e408e8ff031d4661b5d6d4e559482fa353b4fc086d86931

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