KPhotoAlbum

From KDE Wiki Sandbox
Revision as of 20:56, 16 November 2017 by Johanneszarl (talk | contribs) (Replace current version with link to the always up-to-date location.)
KPhotoAlbum is a tool which you can use to easily sort your images. It provides many capabilities to make sorting and viewing images easy.

Earlier versions of KPhotoAlbum were released under the name "KimDaBa". Stable releases are always announced on our news page.

For an introduction, take the 3 minute KPhotoAlbum tour or see the Videos at KPhotoAlbum's Homepage. To learn more and view some screenshots read the FAQ.

KPhotoAlbum supports all the normal image formats including raw formats produced by most digital cameras and scanners (using dcraw to do the decoding). It is also possible to use the thumbnails embedded in raw images (that are usually of decent size and quality) for fast viewing so there is no need to decode the whole raw image.

Using KPhotoAlbum

There is a 3-minute Tour and a set of How-To videos on the project site. A KPhotoAlbum handbook is also available as a PDF and on-line version.

Getting KPhotoAlbum

Source packages, binaries for various distros, and snapshots are available from the project Download page.

KPhotoAlbum on Live systems

KPhotoAlbum is available in Neon:

  • User Edition has the latest release
  • Developer Edition (stable branch) has the 5.x branch.
    Most of the time, this should be the same as unstable, but when new features are developed they only arrive in stable after the roughest edges have been smoothed out.
  • Developer Edition (unstable branch) has the master branch of kphotoalbum.

Building KPhotoAlbum

Step-by-step guide to build KPhotoAlbum from source code on Debian or Ubuntu are available on page Building KPhotoAlbum.

Extending KPhotoAlbum

  • Image::Kimdaba is a perl module available on CPAN which parses the index.xml database.
  • Another way to extend KPhotoAlbum is to write KIPI plugins (that are used also by other KDE photo applications). These plugins provide functions like exporting images to websites like Flickr, Picasa, Facebook, ... correcting exif date stamps or doing some other image manipulations. (KPhotoAlbum by itself does not touch the original files at all but preserves them intact).
  • Other useful scripts are available from Wes Hardaker's site
  • With Kimdaba2Mysql it's possible to:
    • insert your index.xml metadata into a mysql-database
    • generate a search-formular on your website with your kimdaba-keywords, example here
  • Patches and features awaiting approval or implementation - Please use bugs.kde.org for that.


With pse3tokimdaba.pl it's possible to extract information from your Photoshop Elements 3 database to create an index.xml file. There are quite a few limitations, see the above page for more details.

djKPA is a Django web site designed to be the web interface of your KPhotoAlbum photo repository. The philosophy of djKPA is be as far as possible fully automatic: labels, tags, descriptions, ... of photo come from KPhotoAlbum. Nevertheless, djKPA is a real interactive application that allows your visitors to vote, post comments, show exif, ... and visit your photos by browsing the your Tags.

Help develop KPhotoAlbum

If you are interested in helping the KPhotoAlbum development or related projects, please look at this project page. Or, if you have an idea for a feature, please see the Feature Requests section, below.

Developer documentation

KPA Release Steps

  • Update CMakeLists.txt with the new version number you are just about to tag (alas, our automatic versionning doesn't work anymore )
  • Update the ChangeLog to mark the new release and add the key improvements to the list of changes, if they are not already mentioned in the ChangeLog
  • Update doc/index.docbook to reflect the new release (if the documentation has been updated)
    <releaseinfo>4.5</releaseinfo>
  • Commit the last changes
    git commit -v -a
  • Tag the new release and push it out
    git tag -a -m "kpa 4.5 released" v4.5
    git push
    git push --tags
  • Create a tar ball of the released sources using the instructions on the following section (kphotoalbum.rb --version 4.5)
  • Upload the created tar ball to the incoming directory of upload.kde.org using an FTP client. The current instructions of notifying administrators of the upload are shown when logging in to the FTP server. You create a ticket and provide SHA sums and some other information of the upload.
  • Add a new version to Bugzilla (bugs.kde.org, you have to have administrator rights to do this): Edit Products → KPhotoAlbum → Add version
  • Publish the release information (KPA's web site, mailing lists, distributor's bugtracking system, social media etc.).
    • Don't forget to post on the kde-distro-packagers mailing list, and make sure to mention any changes in dependencies.
    • Update the latest version on top of this page.
  • Create a video of the cool new features and publish it on Youtube. A nice tool for doing so is recordmydesktop. If you uploaded such a video, don't forget to add it to the Videos page on the homepage (cf. the README_new_video.txt file).
  • Notify people building the binary packages for different distributions

Building a Release

Building a snapshot tar ball is rather straight forward. Install the releaseme building tool and run a command to generate the source package.

git clone git://anongit.kde.org/releaseme
cd releaseme

To create the source package, run e. g.:

./tarme.rb --origin trunk --version 5.1 kphotoalbum

GIT Branches

  • master (build status)
    Current development branch
  • 4.7
    Old stable (Qt4/Plasma4) branch. Only gets fixes for serious bugs on a case-by-case basis.
  • 5.x
    Branch tracked by Neon/stable.
    When master is in stable condition, it should be synced to 5.x:
    git checkout 5.x ; git merge master
  • Feature branches are used in a very ad-hoc manner. If you are not a developer, don't bother with them.
    If you are a developer, try using descriptive names that are not likely to interfere with future branches.

Known Bugs and feature requests

See the list of Bugs and workarounds in KPhotoAlbum.

Please use [1] marking the report as a "Wish".

New Ideas for Future Versions

If you have a new idea for KPhotoAlbum and think that bugs.kde.org is not the right place for it, use one of the communication channels listed on the pages.