Installation

Requirements

  • Python 3.8 or higher

  • Robot Framework 4.0 or higher

  • GPG/GnuPG installed on your system

System Dependencies

The library requires GnuPG to be installed on your system:

Ubuntu/Debian:

sudo apt-get update
sudo apt-get install gnupg

CentOS/RHEL/Fedora:

sudo yum install gnupg2
# or for newer versions:
sudo dnf install gnupg2

macOS:

brew install gnupg

Windows:

Download and install from: https://www.gnupg.org/download/

Installing the Library

Install from PyPI

pip install robotframework-pgp

Install from Source

git clone https://github.com/ohmrefresh/robotframework-pgp.git
cd robotframework-pgp
pip install -e .

Development Installation

For development, install with development dependencies:

git clone https://github.com/ohmrefresh/robotframework-pgp.git
cd robotframework-pgp
pip install -r requirements-dev.txt
pip install -e .

Verifying Installation

You can verify the installation by running:

python -c "from RobotFrameworkPGP import RobotFrameworkPGP; print('Installation successful')"

Or create a simple Robot Framework test:

*** Settings ***
Library    RobotFrameworkPGP

*** Test Cases ***
Test Installation
    ${version}    Get GPG Version
    Log    GPG Version: ${version}

Configuration

The library will automatically create a temporary GPG home directory if none is specified. You can also specify a custom GPG home directory:

*** Settings ***
Library    RobotFrameworkPGP    gnupg_home=/path/to/gnupg

*** Test Cases ***
Use Custom GPG Home
    Set GPG Home Directory    /path/to/custom/gnupg