pixindex

Index pictures in a folder or in an Amazon S3 bucket. Search by camera, date, and GPS, or by what the picture shows. Find copies of the same shot. Export the catalog.

pixindex is a command-line tool. It does not start a server. It does not run in the background. It does not move, copy, or change your pictures.

pipx install 'pixindex[embed]'

pixindex --db ./catalog.sqlite index ./photos
pixindex --db ./catalog.sqlite embed
pixindex --db ./catalog.sqlite search "red tent at dusk" --camera Nikon
pixindex --db ./catalog.sqlite duplicates
pixindex --db ./catalog.sqlite export csv > inventory.csv

What it records

It finds .jpg, .jpeg, .png, and .webp files. Files and folders whose names start with . are skipped. HEIC and RAW files are not supported.

For each picture it stores:

• the full path, or an S3 location like s3://bucket/key
• file size, width, and height
• camera make and model, if the picture has that information
• date taken, if the picture has that information
• GPS coordinates, if the picture has that information

This information is stored in a SQLite file on your computer. pixindex does not store the pictures themselves.

If you do not pass --db, the catalog file is:

~/.local/share/pixindex/index.sqlite

Install

You need Python 3.12 or newer.

pipx install pixindex
pixindex --help

Or with pip:

pip install pixindex

Searching with words needs an extra install. The first time you use it, pixindex downloads a model of about 600 MB and keeps that model on your computer. Indexing, search filters, finding copies, and export work without this extra.

pipx install 'pixindex[embed]'

Or:

pip install 'pixindex[embed]'

Index

You can index a folder, a single file, or a location in an S3 bucket:

pixindex --db ./catalog.sqlite index ./photos
pixindex --db ./catalog.sqlite index ./photos/beach.jpg
pixindex --db ./catalog.sqlite index s3://my-bucket/photos/2024/

S3 uses your normal AWS credentials. Set AWS_PROFILE or AWS_ACCESS_KEY_ID the same way you would for other AWS tools. pixindex only reads files in the bucket. For JPEG files, it downloads the start of the file, which is enough to read the camera, date, and GPS. For PNG and WebP files, it downloads the whole file.

When it finishes:

Indexed 12, skipped 0, failed 0.

• indexed — the picture was new, or it changed, so it was written to the catalog
• skipped — the picture is already in the catalog, and the file has not changed
• failed — the picture could not be read; pixindex prints the path and continues with the next file

Press Ctrl+C to stop. Pictures that were already saved stay in the catalog. If you run the same command again, files that have not changed are skipped. For photos on your computer, pixindex compares the file size and the last time the file was changed. For photos on S3, it compares the ETag. The ETag is an id that Amazon stores for each file.

The first run over a large folder or S3 location can take a while. Later runs are faster, because most files are only checked to see if they changed.

If AWS credentials are missing, or the bucket cannot be listed, pixindex prints an error and exits.

Picture search

Indexing saves the camera, date, size, and GPS from each file. Picture search looks at the picture, so you can search with words such as "red tent at dusk".

pixindex --db ./catalog.sqlite embed
pixindex --db ./catalog.sqlite search "red tent at dusk"
pixindex --db ./catalog.sqlite search "red tent at dusk" --camera Nikon --after 2024-06-01

embed looks at each picture and saves a short record of what the picture shows. The pictures stay on your computer.

This uses a model called CLIP. The name saved with each picture is Qdrant/clip-ViT-B-32. CLIP runs on your computer. The first run downloads it. Later runs use that download.

embed skips a picture that already has a record from this same model and has not changed. If you switch to a different model, pixindex writes new records. A search uses the records from the current model.

On S3, embed downloads the whole file. Indexing a JPEG only downloads the start of the file, which is enough to read the camera, date, and GPS. When embed finishes, it prints how many pictures it described, how many it skipped, how many failed, and how much data it downloaded.

Embedded 12, skipped 40, failed 0. Read 80.2 MB. Model Qdrant/clip-ViT-B-32.

Press Ctrl+C to stop. Records already saved stay in the catalog.

If a file changed after you indexed it, embed skips that file and prints the path. Run index again, then run embed.

search with words prints the best matches first, one path per line. Any filter you add still applies. Camera, date, and GPS are checked first. The words then put the remaining pictures in order, best match first. The default is 20 pictures. --limit changes that.

Pictures you have not run embed on are left out. pixindex prints how many. Run embed to include them.

A plain explanation of the code is in docs/picture-search.md.

Stat

pixindex --db ./catalog.sqlite stat
pixindex --db ./catalog.sqlite stat --source ./photos

This prints counts, total size, the date range, how many pictures have GPS, and which cameras appear in the catalog. --source prints the same summary for one folder or S3 location you already indexed.

3 pictures
4.9 KB

Taken: 2024-03-12 to 2024-11-02
With GPS: 1 of 3 (33%)

Cameras
  Canon EOS R6     2
  Apple iPhone 15  1

Dates are the earliest and latest day a picture was taken. A picture with no camera is listed as unknown. If the catalog has no pictures, stat prints No pictures in the catalog yet. If the catalog file does not exist yet, stat prints an error and exits.

Search

Each matching picture is printed as one path per line. A picture must match every option you pass.

pixindex --db ./catalog.sqlite search --camera Nikon --has-gps
pixindex --db ./catalog.sqlite search --after 2024-06-01 --before 2024-08-31
pixindex --db ./catalog.sqlite search --ext jpg --min-size 5mb
pixindex --db ./catalog.sqlite search --source ./photos --no-gps
pixindex --db ./catalog.sqlite search --source s3://my-bucket/photos/2024
pixindex --db ./catalog.sqlite search "red tent at dusk" --camera Nikon --limit 10

Paths on your computer are absolute. S3 pictures are printed as s3:// locations.

/photos/beach.jpg
/photos/2024/pier.jpg

• --camera — camera make or model contains this text
• --after / --before — date the picture was taken, in YYYY-MM-DD format. Both days are included. Pictures with no date are left out
• --has-gps / --no-gps — only pictures that have a location, or only pictures that do not
• --ext — file type (jpg also matches .jpeg)
• --min-size — smallest file size to include, for example 5mb
• --source — only pictures from one folder or S3 location you already indexed

If nothing matches, nothing is printed. If you pass a date or size that pixindex cannot read, it prints an error and exits.

When you search with words, pictures you have not run embed on are left out. pixindex prints how many, and tells you to run embed. --limit applies only when you search with words.

Copies

pixindex --db ./catalog.sqlite duplicates

This finds the same photo saved more than once. That includes the original and a smaller copy, or the same file saved in two folders. It compares the shape of the picture. Word search is a separate step and uses CLIP.

Pictures in one group are printed together. A blank line starts the next group.

/photos/beach.jpg
/photos/beach-small.jpg

/photos/scan.png
/photos/scan-copy.png

It also prints a count line:

Hashed 4, skipped 10, failed 0. Read 3.0 MB. 2 groups.

--distance sets how similar two pictures must be to be put in the same group. Use a number from 0 to 64. The default is 8. A smaller number means the pictures must look more alike. 0 means the shapes must match. --source limits this to one folder you already indexed.

A second run skips pictures that were already compared and have not changed. On S3, the first run downloads the whole file, same as embed.

Export

Export uses the same filters as search. Results are printed in the terminal. To save them to a file, use > as in the examples below.

pixindex --db ./catalog.sqlite export csv > inventory.csv
pixindex --db ./catalog.sqlite export json > inventory.json
pixindex --db ./catalog.sqlite export csv --camera Nikon --has-gps > nikon-gps.csv

Use csv if you want to open the file in a spreadsheet. Use json if you want to read it from a script. One CSV row looks like this:

uri,source,size,width,height,captured_at,camera_make,camera_model,has_gps,gps_lat,gps_lon
/photos/beach.jpg,/photos,2400000,6000,4000,2024-07-14T15:02:11,Nikon,Z 6,true,33.6844,73.0479

The same picture as JSON:

[
  {
    "uri": "/photos/beach.jpg",
    "source": "/photos",
    "size": 2400000,
    "width": 6000,
    "height": 4000,
    "captured_at": "2024-07-14T15:02:11",
    "camera_make": "Nikon",
    "camera_model": "Z 6",
    "has_gps": true,
    "gps_lat": 33.6844,
    "gps_lon": 73.0479
  }
]

uri is the picture. source is the folder or S3 location you indexed. If the camera, date, or GPS is missing, that CSV cell is empty. In JSON the value is null. If no pictures match, the export is still valid. CSV will contain only the header row. JSON will be an empty list: []. The format must be csv or json.

Check

pixindex check

This makes a few example pictures, runs picture search and duplicates, and prints how many checks passed. It leaves your catalog alone. Run it after you change the model. You need the extra install from the Install section.

Picture search: 2/2
Duplicates: 1/1

If a check fails, the command exits with an error.

Development

python3.12 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
pytest

pytest does not download CLIP. To run CLIP on your computer, install the extra too: pip install -e ".[dev,embed]", then pixindex check.

How picture search and finding copies work in the code is explained in docs/picture-search.md.

On Ubuntu, if python3.12 -m venv fails, run sudo apt install python3.12-venv.

License

MIT