KeePass Library

This library enables Robot Framework to interact with KeePass databases.

Supported KeePass versions:

• KDBX3
• KDBX4

KeepassLibrary uses the PyKeePass modules internally to access KeePass databases

See https://keepass.info for more information about KeePass in general

Keyword Documentation

See keyword documentation for available keywords and more information about the library in general.

Installation

The recommended approach to install KeePassLibrary, regardless the version, is using pip.

Install (or upgrade) the latest KeePassLibrary version:

pip install --upgrade robotframework-keepasslibrary

Example

*** Settings ***
Documentation     A test suite with a single test for retrieving a password.
...
...               The test opens a KeePass database named Database.kdbx using 
...               the keyfile Database.key. 
...               It then retrieves the first entry that matches the Username "User Name"
...               and logs the password from the returned KeePass database entry
Library           KeePassLibrary

*** Test Cases ***
Get KeePass Database Entry
    Open KeePass Database       Database.kdbx    keyfile=Database.key        
    ${entry}=    Get Entries By Username    User Name    first=True
    ${value}=    Get Entry Password    ${entry}  
    Log     Password for User Name is ${value}

Versions:

• 0.12.0 New keywords, Robot Framework 7.4 secret variable support
• 0.11.0 Updated supported Python versions to include Python 3.14, Updated dependencies, refactoring for deprecated pykeepass functions
• 0.10.0 New keywords for accessing entry attachments, updated dependencies
• 0.9.0 Updated dependencies, updated supported Python versions to include Python 3.13, dropped Robot Framework 4.1.3 support
• 0.8.0 New keywords for accessing entry and group time attributes
• 0.7.0 Updated dependencies, dropped python 3.7 support
• 0.6.0 Updated dependencies, dropped Robot Framework 3.2.2 support
• 0.5.0 Updated dependencies, rework for pykeepas 4.1, dropped python 3.6 support
• 0.4.1 Updated dependencies
• 0.4.0 Updated dependencies, rework for pykeepas 4.x with keyfile v2 support, additional test cases
• 0.3.1 Updated dependencies, tests moved to GitHub actions
• 0.3.0 New keywords for accessing entry and group data, rebuild of code using Python Library Core.
• 0.2.5 Fix manifest, additional test cases
• 0.2.4 Updated dependencies
• 0.2.3 Updated dependencies, new travis builds
• 0.2.2 Updated dependencies
• 0.2.1 KDBX v3 and v4 test cases
• 0.2.0 Group Support
• 0.1.0 Entry Support