Skip to main content

pictures & video preparation tool for piwigo

Project description

piwiPre

piwiPre is a python/windows tool to prepare pictures and video for piwigo (and any other album management), and maintain the piwigo album and database

It was initially developed for a piwigo instance running on a remote server such as a Synology NAS, while the 'photo' and 'thumbnails' directories are accessible from a PC where piwiPre is run, but it can run on many other configurations.

Many features can be useful even when piwigo is not used.

piwiPre executes the following tasks:

  1. Read configuration files and command-line argument to insure a high level of configuration.

  2. Process new pictures/video on the local host in the TRIAGE directory and copy them on the piwigo server

    • process copy of content and leave original unmodified
    • convert most (managed by python) pictures formats to JPG
    • convert most (managed by ffmpeg) video formats to MP4
    • realign picture rotation, according to EXIF data
    • perform correction on picture/video dates according to settings
    • insert metadata (copyright, instructions, author) in the JPEG IPTC or MP4 file
    • rename pictures according to a user-defined scheme
    • replace by '_' characters that piwigo does not support in filenames
    • avoid collision of filenames
    • create the corresponding sub-album in piwigo, inserted in the increasing order of subdirectories
    • put updated copies into ALBUM, through file copy, NFS or ssh/sftp
    • build piwigo thumbnails, even for video
    • copy thumbnails to the appropriate location, through file copy, NFS or ssh/sftp
    • self-configure ALBUM for maintenance
    • update the piwigo SQL database with metadata and MD5 checksum
  3. Maintain ALBUM

    • work only on selected directories
    • Ensure the directory is aligned with the current configuration
    • Insert pictures and video in the piwigo database, with metadata, md5 checksum and author
    • Update the information stored in the piwigo database
  4. log intensively the actions

piwiPre comes with:

  • a Windows installer: pwpInstaller.exe, with and without Graphical User Interface (--gui true)
  • a GUI that can be used to configure and/or run the program : piwiPre --gui true
  • cmdline versions of piwiPre and pwpInstaller
  • a python version of pwpConfigurator, that runs on Linux and Windows
  • Python source code,
  • a Python library downloadable from Pypi,
  • Windows Executable versions
  • 74 configuration items
  • a complete user documentation in English and French (see bellow)
  • test coverage at 95% of the code

what piwiPre does not

piwiPre does not manage synology thumbnails created by Synology file-station in @eaDir directories, which is not a concern because those thumbnails are small (less than 500KB).

How to get piwiPre

How to use piwiPre (short)

  1. Copy new pictures and videos from your cameras to the TRIAGE directory.

  2. Create subdirectories is TRIAGE according to your taste

    • The name of the subdirectory will be a base for the new filename of pictures
    • move files into one of those.
  3. Optionally edit the pictures in TRIAGE with digiKam, gimp or other image processing tool.

  4. If you want managed files to be written to a remote piwigo server, then you need a piwiPre.ini configuration file.

    • If it does not exist, create one by running 'piwiPre --gui true'
    • If ALBUM, THUMBNAILS and AUTO-CONFIG directories are accessible, album, thumbnails and auto-config should be set.
    • If the sql database is accessible, sql-user, sql-pwd, sql-host, sql-port should be set.
    • You may want to change the (english speaking) default values for month-name, copyright, instructions.
  5. Run piwiPre

  6. Results:

    • pictures have metadata inserted
    • picture rotation is reset to default
    • Files are renamed according to directories, dates
    • the thumbnails are generated
    • the corresponding sub-album has been created in piwigo, inserted in the increasing order of subdirectories
    • files have been copied to ALBUM
    • piwigo database is updated
    • so, the corresponding pictures should be visible in piwigo without further action
    • piwiPre.log holds an exhaustive log

piwiPre as a tool

piwiPre is also a command-line tool, with command-line options. For more information:

piwiPre --help or python -m piwiPre --help

Documentation

Documentation is built using Sphinx https://www.sphinx-doc.org/

Documentation is generated in https://fabien_battini.gitlab.io/piwipre/html/ This process is achieved automatically through gitlab CI pipelines.

gitlab: https://gitlab.com/fabien_battini/piwipre

doc : https://fabien_battini.gitlab.io/piwipre/html/

test coverage: https://fabien_battini.gitlab.io/piwipre/html/htmlcov/index.html

pypi: https://pypi.org/project/piwipre/

LinkedIN: https://www.linkedin.com/in/fabien-battini-supelec/

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

piwipre-0.20.6.tar.gz (180.8 kB view details)

Uploaded Source

Built Distribution

piwiPre-0.20.6-py3-none-any.whl (163.3 kB view details)

Uploaded Python 3

File details

Details for the file piwipre-0.20.6.tar.gz.

File metadata

  • Download URL: piwipre-0.20.6.tar.gz
  • Upload date:
  • Size: 180.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for piwipre-0.20.6.tar.gz
Algorithm Hash digest
SHA256 ef78642fdf85446b87cd47cd61037b3cfef6e963882a20ee0eb4ec7035cec30f
MD5 2a1afd23792432e49111bd7c57a65085
BLAKE2b-256 18a065bf2758afac223da3c3940e88e191780c2a7be2a97290cb7b2231388225

See more details on using hashes here.

File details

Details for the file piwiPre-0.20.6-py3-none-any.whl.

File metadata

  • Download URL: piwiPre-0.20.6-py3-none-any.whl
  • Upload date:
  • Size: 163.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for piwiPre-0.20.6-py3-none-any.whl
Algorithm Hash digest
SHA256 0230d1bd5dd82fd2b24aa618ca671e315b9c9fcc37f4667d3e9ff4421a40dce0
MD5 8fb8d46655366fd2f3d7cea4b7c3864e
BLAKE2b-256 15803b66989853d0724fd33e13dec2b415c773dd856593dc18110f588a13073e

See more details on using hashes here.

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