2.1. Installing XOA Driver

XOA Driver is available to install and upgrade via the Python Package Index. Alternatively, you can also install and upgrade from the source file.

2.1.1. Prerequisites

Before installing XOA Driver, please make sure your environment has installed Python and pip.

Python

XOA Driver requires that you install Python on your system.

Note

XOA Driver requires Python >= 3.11

pip

Make sure pip is installed on your system. pip is the package installer for Python . You can use it to install packages from the Python Package Index and other indexes.

Usually, pip is automatically installed if you are:

If you don’t have pip installed, you can:

Install pip in Windows environment.
> py get-pip.py
Install pip in macOS/Linux environment.
$ python3 get-pip.py

See also

Read more details about this script in pypa/get-pip.

Read more about installation of pip in pip installation.

2.1.2. Installing From PyPI Using pip

pip is the recommended installer for XOA Driver. The most common usage of pip is to install from the Python Package Index using Requirement Specifiers.

Install to Global Namespace

Install XOA Driver in Windows environment from PyPi.
> pip install tdl-xoa-driver -U         # latest version
> pip install tdl-xoa-driver==1.1.0     # specific version
> pip install tdl-xoa-driver>=1.1.0     # minimum version
Install XOA Driver in macOS/Linux environment from PyPi.
$ pip3 install tdl-xoa-driver -U         # latest version
$ pip3 install tdl-xoa-driver==1.1.0     # specific version
$ pip3 install tdl-xoa-driver>=1.1.0     # minimum version

Install in Activated Virtual Environment

Install XOA Driver in a virtual environment, so it does not pollute your global namespace.

For example, your project folder is called /my_xoa_project.

Install XOA Driver in a virtual environment in Windows from PyPI.
[my_xoa_project]> python -m venv .\env
[my_xoa_project]> .\env\Scripts\activate

(env) [my_xoa_project]> pip install tdl-xoa-driver
Install XOA Driver in a virtual environment in macOS/Linux from PyPI.
[my_xoa_project]$ python3 -m venv ./env
[my_xoa_project]$ source ./env/bin/activate

(env) [my_xoa_project]$ pip3 install tdl-xoa-driver

See also

Deactivate Virtual Environment

You can deactivate a virtual environment by typing deactivate in your shell.

Deactivate virtual environment on Windows.
(env) [my_xoa_project]> deactivate
[my_xoa_project]>
Deactivate virtual environment on macOS/Linux.
(env) [my_xoa_project]$ deactivate
[my_xoa_project]$

2.1.3. Upgrading From PyPI Using pip

To upgrade XOA Driver package from PyPI:

Upgrade XOA Driver in Windows environment from PyPi.
> pip install tdl-xoa-driver -U
Upgrade XOA Driver in macOS/Linux environment from PyPi.
$ pip3 install tdl-xoa-driver -U

2.1.4. Installing Manually From Source

If for some reason you need to install or upgrade XOA Driver manually from source, the steps are:

Step 1, make sure Python packages wheel and setuptools are installed on your system. Install wheel and setuptools using pip:

Install wheel and setuptools in Windows environment.
> pip install wheel setuptools
Install wheel and setuptools in macOS/Linux environment.
$ pip3 install wheel setuptools

Step 2, download the XOA Driver source distribution from XOA Driver Releases. Unzip the archive and run the setup.py script to install the package:

Install XOA Driver in Windows environment from source.
[xoa_driver]> python setup.py install
Install XOA Driver in macOS/Linux environment from source.
[xoa_driver]$ python3 setup.py install

Step 3, if you want to distribute, you can build .whl file for distribution from the source:

Build XOA Driver wheel in Windows environment for distribution.
[xoa_driver]> python setup.py bdist_wheel
Build XOA Driver wheel in macOS/Linux environment for distribution.
[xoa_driver]$ python3 setup.py bdist_wheel