Skip to main content

A tool for presenting images that match the description.

Project description

English description follows Japanese.


概要

mood_img は、与えられた説明文にもっともマッチする画像を提示する Python ライブラリです。 プレゼン資料、スライド、動画などで適切な画像を探したいときに役立ちます。

特徴

  • 説明文から画像検索: 例:「毎朝朝食を急いで食べます」→ 朝食の写真を取得
  • ローカル画像から選定: ユーザー自身が指定した画像ディレクトリ内から選ばれます
  • 重複回避機能: 同じスクリプト実行中は、同じ画像が繰り返し選ばれにくくなっています
  • コマンドライン対応: Python スクリプトなしでも画像取得が可能です

使い方

1. 初期設定

画像ファイルが入っているディレクトリを指定します。これは最初に一度だけ必要です。

import mood_img

mood_img.set_imgdir("path/to/imgs")

2. 画像を取得する

任意の説明文に対応する画像のパスが返されます。

print(mood_img.get("私がタヌキで"))	# 例: ./imgs/tanuki01.png
print(mood_img.get("こちらがキツネです。"))	# 例: ./imgs/fox_surprised.jpg

3. コマンドラインから使用

mood_img "私がタヌキで" "こちらがキツネです。"

カレントディレクトリに 0.png, 1.jpg のような形式で画像が保存されます。

注意点

  • 画像ディレクトリの準備が必要: このライブラリはインターネット検索を行わないため、利用者自身が画像ファイルを用意する必要があります。
  • 画像の重複は完全には防げない: 可能な限り回避されますが、候補画像が足りない場合は重複することがあります。

Overview

mood_img is a Python library that helps you find the most fitting image based on a given description. It is especially useful when creating slides, presentations, or videos and you want an image that matches a specific mood or sentence.

Features

  • Text-to-image matching: Example: "I rush through breakfast every morning" → Image of a breakfast
  • Uses local image directory: Images are selected from a directory specified by the user
  • Avoids duplicate selections: Within a single script run, it tries not to return the same image multiple times
  • Command-line usage available: Can be used without writing any Python code

Usage

1. Initial Setup

You must first specify the image directory containing your image files.

import mood_img

mood_img.set_imgdir("path/to/imgs")

2. Retrieve images

Pass a description, and the path to the most relevant image will be returned.

print(mood_img.get("I am a tanuki"))	# Example: ./imgs/tanuki01.png
print(mood_img.get("This one is a fox."))	# Example: ./imgs/fox_surprised.jpg

3. Command-line usage

mood_img "I am a tanuki" "This one is a fox."

This will generate 0.png, 1.jpg, etc., in the current working directory.

Notes

  • You must prepare image files: This tool does not fetch images from the internet. You need to provide a local image dataset.
  • Duplicate images may still appear: While it tries to avoid showing the same image more than once, duplicates can occur if there are not enough available options.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mood_img-0.0.2-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file mood_img-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: mood_img-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 6.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.3

File hashes

Hashes for mood_img-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 208b24d161c3796b59c27c7eb7d90fa6c40f2a177f4b67fe370c6a367773a0e9
MD5 f8ea8e4989039be102e1f00bb1df8ddc
BLAKE2b-256 b566be9dd7b51e2103d5f173920e34d49284e54ba85fda9b1afec8db1f0f8512

See more details on using hashes here.

Supported by

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