Tags: user, how-to

Setting Up PyLinkAhead

This guide covers installing and configuring PyLinkAhead, the Python client for LinkAhead.

Installation

First ensure that Python (at least version 3.10) is installed. If it is not yet installed, follow the Installing Python section for your OS.

It is recommended to install PyLinkAhead inside a virtual environment:

python3 -m venv venv
source venv/bin/activate  # on Windows: venv\Scripts\activate

Then install the client using pip:

pip install linkahead

Installing Python

Linux

Make sure that Python (at least version 3.10) and pip are installed using your system’s package manager, then continue with the Installation section above.

Windows

If a Python distribution is not yet installed, download and install it from python.org, or install a recent Python version from the Microsoft Store. After installation, open a command or PowerShell prompt and continue with the Installation section above.

MacOS

If Python 3 is not yet installed, download it from python.org or install via Homebrew. After installing from python.org, update the TLS certificates (replace the version number with yours):

cd /Applications/Python\ 3.x/
sudo ./Install\ Certificates.command

Then continue with the Installation section above.

Configuration

PyLinkAhead reads connection settings (server URL, credentials, and SSL options) from an ini configuration file. See the PyLinkAhead Configuration Reference for all available options, or the How to Configure PyLinkAhead guide for step-by-step authentication and SSL setup.

Next Steps

Once installed and configured, continue with the Python client tutorials.

For development and contribution instructions, see the PyLinkAhead Development Guide.