Skip to main content

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

Project description

pupyl

pupyl-ci codecov CII Best Practices

pupyl - A Python Image Search Library

🧿 pupyl what?

The pupyl project (pronounced pyoo·piel) is a pythonic library to image search. It's intended to made easy to read, index, retrieve and maintain a complete a 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 pupyl

🚸 Usage

import tempfile

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


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

SEARCH = PupylImageSearch(data_dir=tempfile.gettempdir())

SEARCH.index(SAMPLES)

🕐 Processed 12942 items

interface.serve()

📌 Dependencies

See all dependencies here: dependencies.

🐧 Linux

Some linux distros are packaged without some essential applications to built pupyl dependencies. If during the installation you face errors like this:

error: command 'x86_64-linux-gnu-gcc' failed with exit status 1

try install C/C++ build dependencies and python development headers, like this:

# Debian/Ubuntu
sudo apt install build-essential python3-dev

# Fedora
sudo dnf install make automake gcc gcc-c++ kernel-devel python3-devel

# Redhat/CentOS
sudo yum groupinstall 'Development Tools'
sudo yum install python3-devel

# Suse/OpenSuse
zypper install -t pattern devel_basis
zypper install python3-dev

# Arch
sudo pacman -S base-devel python3-dev

# Clearlinux
sudo swupd bundle-add c-basic python-basic-dev

📝 Documentation

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

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

pupyl-0.9.8.tar.gz (18.1 kB view hashes)

Uploaded Source

Built Distribution

pupyl-0.9.8-py3-none-any.whl (23.9 kB view hashes)

Uploaded Python 3

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