pupyl 0.10.4

🧿 Pupyl is a really fast image search library which you can index your own (millions of) images and find similar images in millisecond.

pupyl - A Python Image Search Library

🧿 pupyl what?

The pupyl project (pronounced pyoo·piel) is a pythonic library to perform image search tasks. It's intended to made easy reading, indexing, retrieving and maintaining a complete reverse image search engine. You can use it in your own data pipelines, web projects and wherever you find fit!

🎉 Getting started

📦 Installation

Installing pupyl on your environment is pretty easy:

# pypi
pip install pupyl

or

# anaconda
conda install -c policratus pupyl

For installation troubleshooting, visit troubleshooting.

🚸 Usage

from pupyl.search import PupylImageSearch
from pupyl.web import interface


SAMPLES = 'https://github.com/policratus/pupyl' + \
          '/raw/master/samples/images.tar.xz'

SEARCH = PupylImageSearch()

SEARCH.index(SAMPLES)

interface.serve()

Disclaimer: the example above creates pupyl assets on your temporary directory. To define a non-volatile database, you should define data_dir parameter.

📌 Dependencies

See all dependencies here: dependencies.

📝 Documentation

See a quick reference guide on the repository wiki. Complete API reference coming soon.