Windows development: one time system configuration

Please adapt these instructions to your setup. The steps outlined here were tested to work.

Install Chocolatey

In an Administrator command prompt:

Install misc utilities:

• choco install 7zip

Install Python 3.12:

• choco install python --version 3.12.0 --params "'/qn /norestart ALLUSERS=1 TARGETDIR=c:\Python312'"

Python will install to C:\Python312 for all users.

Restart the Administrator command prompt to pick up the new python and run the following:

• python -m pip install --upgrade pip
• python -m pip install --upgrade setuptools

Install the Microsoft Visual C++ compiler, per https://wiki.python.org/moin/WindowsCompilers:

• choco install visualstudio2022community

Then run 'Visual Studio Installer' from the Start menu, and enable the 'Python development' workload, plus the 'Python native development tools' option. See the pyhon wiki for more details.

Install cygwin with needed packages:

• choco install cygwin --params "/InstallDir:C:\cygwin64"
• choco install rsync openssh --source=cygwin

Windows development: python virtualenv setup

Next, prepare a python virtualenv with all the necessary dependencies. This step needs to be repeated in every fresh clone of the repository.

Open a Visual Studio Developer command prompt in the steamos-devkit folder and run the following:

• setup: python -m venv .

• activate: .\Scripts\activate.bat

  If you get an UnauthorizedAccess error due to execution policies, run the following command first: Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process

Start by updating base tools:

• python -m pip install --upgrade pip
• python -m pip install --upgrade setuptools

Install project dependencies:

• pip install -r requirements.txt

You are ready for development. The application can be started by running python .\client\devkit-gui.py.

Windows packaging:

From the activated virtual env:

• python .\setup\package-windows.py

Linux development:

We recommended a system with Python 3.9 or 3.10 (Arch and derivatives, or Ubuntu 20.x or newer)

Instructions below use pipenv, but can be adapted to any other python virtual environment solution.

• pipenv shell
• pip install -r requirements.txt

(Assuming you are on a Python 3.10 system, see wheels documentation below)

• cd client
• ./devkit-gui.py

Linux packaging for distribution:

One time setup:

From a blank Ubuntu 20.04 (focal) - via VM, toolbox, podman, docker etc.:

Installing 3.9, 3.10, 3.11, 3.12 backports from https://launchpad.net/~deadsnakes/+archive/ubuntu/ppa

As root:

$ add-apt-repository ppa:deadsnakes/ppa
$ apt-get update
$ apt-get upgrade
$ apt-get install gcc g++ python3.9 python3.9-dev python3.9-distutils python3.10 python3.10-dev python3.10-distutils python3.11 python3.11-dev python3.11-distutils python3.12 python3.12-dev python3.12-distutils

Boostrapping pip and pipenv.

As user:

$ wget https://bootstrap.pypa.io/get-pip.py
$ python3.9 ./get-pip.py
$ python3.9 -m pip install pipenv
$ python3.10 ./get-pip.py
$ python3.10 -m pip install pipenv
$ python3.11 ./get-pip.py
$ python3.11 -m pip install pipenv
$ python3.12 ./get-pip.py
$ python3.12 -m pip install pipenv

Package:

• Fresh git clone
• python3.9 -m pipenv --python 3.9 shell
• pip install -r requirements.txt
• ./setup/package-linux.py

Repeat for Python 3.10 etc.