Skip to main content

Import photos from various sources to Immich

Project description

Immichporter

Immichporter

Import your Google Photos structure and sharing info into Immich — metadata only, no image data.

Documentation | PyPI


[!WARNING]

  • Still experimental: Google Photos export works in some cases, but stability issues remain.
  • Only works in English

Immichporter retrieves metadata not available in google takeout, including shared albums, assets, and shared users. You can use this data to update assets in Immich, re-add users to shared albums, and even move assets to their correct owners.

[!IMPORTANT]

  • This tool does not download any images from google photos. It only extracts the information into a local database.
  • Make sure to manually save all shared pictures in google photos before running a takeout.

Use google takeout to export your google photos assets and immich-go to import the data into immich.

Installation

Run it directly with uv (recommended):

uvx immichporter -h

or install it:

Using:

uv add immichporter

Or with pip:

pip install immichporter

Usage

NOTE: You need to import the assets into immich first, before running photos sync to immich.

# Show help
immichporter --help

# login is required the first time, the session is saved
immichporter gphotos login

# add all albums to the database
immichporter gphotos albums

# add all photos for each album to the database
# it can run multiple times and only processes the not fully processed albums again
immichporter gphotos photos

# multiple runs might be needed until everything is correct,
# you can check with if every album is fully processed
immichporter db show-albums --not-finished
# run again
immichporter gphotos photos --not-finished

# edit/update users
immichporter db show-users
immichporter db edit-users # select which users should be added to immich

# see the database with https://sqlitebrowser.org
sqlitebrowser immichporter.db

# !! CAUTION: create a backup of your immich database before running this commands !!

export IMMICH_ENDPOINT=http://localhost:2283
export IMMICH_API_KEY=your_api_key
export IMMICH_INSECURE=1

# this steps are needed to get the immich ids into the 'immichporter.db' sqlite database
# and create non existing users and albums in immich
immichporter immich update-albums
immichporter immich update-users

# delete ablums (optional) if you want to start over
# !! this delete all albums in immich !!
# this is only needed if you have different album names in immich
immichporter immich delete-albums

# sync albums to immich (create albums and users, add assets to albums)
immichporter sync-albums --dry-run  
immichporter sync-albums

TODO

  • get all ablums from gphotos
  • get all metadata from photos inside the albums (shared with, timestamp, ...)
  • update user information (local DB)
  • create or update albums in immich
  • create or update users in immich
  • add/update assets to albums in immich
  • move assets to correct user (needs to be tested)
  • improve documentation
  • interactive wizard with ui (web or gui ...)
  • submit changes to server for an admin to review and update

Development

Dependencies

Setup

To set up the development environment:

# Clone the repository
git clone https://github.com/burgdev/immichporter.git
cd immichporter

# Install development dependencies
just install
source .venv/bin/activate

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for details.

License

MIT - See LICENSE for details.

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

immichporter-0.0.5.tar.gz (174.0 kB view details)

Uploaded Source

Built Distribution

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

immichporter-0.0.5-py3-none-any.whl (595.7 kB view details)

Uploaded Python 3

File details

Details for the file immichporter-0.0.5.tar.gz.

File metadata

  • Download URL: immichporter-0.0.5.tar.gz
  • Upload date:
  • Size: 174.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for immichporter-0.0.5.tar.gz
Algorithm Hash digest
SHA256 4da43ca100134d5c3dd7e0cddfc73d5e03d8fd862684c1862e20a7868dabbae0
MD5 77d6bdbda28fe5af29000755dcd2e6a7
BLAKE2b-256 b6c594520b964bcf4bda91213ea5b2dc65f514f0ea0ebf2a8df70da081b97690

See more details on using hashes here.

Provenance

The following attestation bundles were made for immichporter-0.0.5.tar.gz:

Publisher: publish-pypi.yml on burgdev/immichporter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file immichporter-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: immichporter-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 595.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for immichporter-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8cc0f2837997a72b04f46412a8aa368f8f95400dfd11a5c1bbeaefbbda4b3fc7
MD5 50a93dbe4e77f2d37f2a7aba14e94fe9
BLAKE2b-256 5b84bdf4cc2d5e0ea56da73be51d1565744286ae2976e101cd21324a28aea431

See more details on using hashes here.

Provenance

The following attestation bundles were made for immichporter-0.0.5-py3-none-any.whl:

Publisher: publish-pypi.yml on burgdev/immichporter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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