https://github.com/rcw-2/python-digikamdb

Python library to access Digikam metadata
https://github.com/rcw-2/python-digikamdb

digikam library photography python

Last synced: 3 months ago
JSON representation

Python library to access Digikam metadata

• Host: GitHub
• URL: https://github.com/rcw-2/python-digikamdb
• Owner: rcw-2
• License: mit
• Created: 2022-07-10T12:38:51.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2025-01-26T13:18:56.000Z (over 1 year ago)
• Last Synced: 2025-09-22T19:55:08.711Z (9 months ago)
• Topics: digikam, library, photography, python
• Language: Python
• Homepage:
• Size: 471 KB
• Stars: 14
• Watchers: 4
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
|PyPi Package| |Documentation Status| |Test Status|

Digikam-DB

===========

Python library to access Digikam metadata (database)

Digikam is an image management application using KDE.

For more information on Digikam, see https://www.digikam.org/.

Digikam-DB can read and write Digikam metadata. It works with both

SQLite and MySQL databases.

.. warning::

    

    This package is still under development. Use at your own risk and make

    a backup of your Digikam database before writing to it.

Installation

-------------

For installation via PIP, simply type:

.. code-block:: bash

    

    pip install Digikam-DB

If you are using a MySQL database, you may want to install the additional

dependencies:

.. code-block:: bash

    

    pip install Digikam-DB[mysql]

To get the source code, go to https://github.com/rcw-2/python-digikamdb.

Running the Tests

------------------

The MySQL tests need a MySQL database to run. The database must be specified

in a module ``mysql_data`` somewhere in the Python path (e.g. in the same

directory as this file, it will be ignored by Git) that defines the variables

``db_host``, ``db_user``, ``db_pass`` and ``db_name``. The given user must

have all privileges on the given database.

To fill the database, the ``mysql`` binary is called, so make sure to

have ``mysql-client`` installed.

.. |PyPi Package| image:: https://badge.fury.io/py/Digikam-DB.svg

    :target: https://badge.fury.io/py/Digikam-DB

.. |Documentation Status| image:: https://readthedocs.org/projects/digikam-db/badge/?version=latest

    :target: http://digikam-db.readthedocs.io/?badge=latest

.. |Test Status| image:: https://github.com/rcw-2/python-digikamdb/actions/workflows/test.yml/badge.svg

    :target: https://github.com/rcw-2/python-digikamdb/actions/workflows/test.yml