Proton VPN GTK app

This is our Proton VPN GTK app for Linux!

Development

Even though our CI pipelines always test and build releases using Linux distribution packages, you can use pip to set up your development environment.

Proton package registry

If you didn't do it yet, to be able to pip install ProtonVPN components you'll need to set up our internal Python package registry. You can do so running the command below, after replacing {GITLAB_TOKEN} with your personal access token with the scope set to api.

pip config set global.index-url https://__token__:{GITLAB_TOKEN}@gitlab.protontech.ch/api/v4/groups/777/-/packages/pypi/simple

In the index URL above, 777 is the id of the current root GitLab group, the one containing the repositories of all our ProtonVPN components.

Linux distribution package dependencies

This component depends on the PyGObject python package. Unfortunately, quite a few distribution packages are required before being able to pip install it. Please check the required distribution packages in the official documentation.

Virtual environment

You can create the virtual environment and install the rest of dependencies as follows:

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Unit Tests

You can run the tests with:

pytest

Integration tests

You can run the integration tests with:

behave tests/integration/features

On headless systems, it's possible to run the integration tests using Xvfb (virtual framebuffer X server). On Debian-based distributions, you just have to install the xvfb package. After that, you can run the integration tests with:

xvfb-run -a behave integration_tests/features