Issue installing with Python 3.12.3 and pip3 24.0 on Ubuntu 24.04

[z16]

Following the guide on a rather freshly set up Ubuntu 24.04 machine, I get to this line in the guide:

pip3 install -r server/tools/requirements.txt

This results in this error, and aborts:

It seems I either have to provide an override to the command to install packages system-wide, use a package-dependent python command or set up a virtual environment? I'm just wondering how to proceed and what the implications of each choice are, since I know next to nothing about Python, and the guide does not mention this. Any recommendations?

[zach2good]

What I'm doing in upcoming CI builds is to override this behaviour entirely by running this to set the global setting:

python3 -m pip config set global.break-system-packages true

It's not Python best practice, but it's what we're used to 👍

At some point, we'll figure out how venv's work and we'll use them, but that won't be coming any time soon

[cocosolos]

venv is pretty straight forward to setup.

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

You'll have (.venv) next to your shell prompt to indicate that it's active and can type deactivate to exit the environment.

[zach2good]

Straightforward, sure, but in relation to how much we're asking users (who don't really understand what's going on), that's substantially more line for them to handle compared to: ``` git clone --recursive https://github.com/LandSandBoat/server.git py -3 -m pip install -r server/tools/requirements.txt cp server/settings/default/* server/settings ``` and I don't really want to ship a `setup.sh`/`setup.bat`, so, it feels like a difficult balance to strike

…

On Thu, Oct 24, 2024 at 7:32 PM Corey ***@***.***> wrote: venv is pretty straight forward to setup. python3 -m venv .venvsource .venv/bin/activate python -m pip install -r requirements.txt You'll have (.venv) next to your shell prompt to indicate that it's active and can type deactivate to exit the environment. — Reply to this email directly, view it on GitHub <#6385 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAKTJIOGXUTUOV6WZFS7W73Z5E4NLAVCNFSM6AAAAABQQZIWRCVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTCMBUGQZTENY> . You are receiving this because you commented.Message ID: ***@***.***>

[zach2good]

Actually, `setup_python.sh`/`setup_python.bat` doesn't feel so bad, after 5 minutes of thinking about it :D

…

On Fri, Oct 25, 2024 at 11:36 AM Zach Toogood ***@***.***> wrote: Straightforward, sure, but in relation to how much we're asking users (who don't really understand what's going on), that's substantially more line for them to handle compared to: ``` git clone --recursive https://github.com/LandSandBoat/server.git py -3 -m pip install -r server/tools/requirements.txt cp server/settings/default/* server/settings ``` and I don't really want to ship a `setup.sh`/`setup.bat`, so, it feels like a difficult balance to strike On Thu, Oct 24, 2024 at 7:32 PM Corey ***@***.***> wrote: > venv is pretty straight forward to setup. > > python3 -m venv .venvsource .venv/bin/activate > python -m pip install -r requirements.txt > > You'll have (.venv) next to your shell prompt to indicate that it's > active and can type deactivate to exit the environment. > > — > Reply to this email directly, view it on GitHub > <#6385 (comment)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AAKTJIOGXUTUOV6WZFS7W73Z5E4NLAVCNFSM6AAAAABQQZIWRCVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTCMBUGQZTENY> > . > You are receiving this because you commented.Message ID: > ***@***.***> >

[cocosolos]

Straightforward, sure, but in relation to how much we're asking users (who don't really understand what's going on), that's substantially more line for them to handle compared to: git clone --recursive https://github.com/LandSandBoat/server.git py -3 -m pip install -r server/tools/requirements.txt cp server/settings/default/* server/settings and I don't really want to ship a setup.sh/setup.bat, so, it feels like a difficult balance to strike

Agree, that's why I never bothered putting it in the wiki lol

Actually, setup_python.sh/setup_python.bat doesn't feel so bad, after 5 minutes of thinking about it :D

I had some setup and update scripts at one point. The install script hasn't been updated to use the new settings layout but you can check them out here. idk how I feel about having scripts just to setup a venv though.

[z16]

Having gone through these steps just now I feel it's simple enough to just ask people to do it. It really doesn't add much extra complexity, they already have to execute a bunch of commands, telling them to execute three more (one to set up the environment, one to enter it, and, at the end, one to leave it) seems reasonable enough. If you want, I can adjust the wiki for it? But I understand if you'd prefer to ship an extra script for it. Would give the possibility to bundle up even more things into the script, like executing the DB tool directly within it.

[EDGECOM666]

not sure if you would want to use desktop shortcut to setup DB tools or not but I made this for my server as I got tired of opening a term and typing stuff lol ( I know I am lazy)

I made 2 shortcuts one to install the requirements and one to launch the DB tools it will launch in its own env.
I have tested the shortcuts and they work on ubuntu 24.04 on a default server install

Note: you only need to run the Install Requirements shortcut once as it will complain about already being installed

[zach2good]

It's cool that you're trying to help, but it's pretty suspect to upload zips asking people to download them and run the contents. I've had a look and the content isn't malicious, but you could just be putting the contents of these out in the open so they don't look dodgy:

FFXI Server Launcher.desktop

[Desktop Entry]
Name=Install XI DB Tool Requirements
Comment=Use the command line
Keywords=shell;prompt;command;commandline;cmd;
TryExec=gnome-terminal
Exec=gnome-terminal --window -- bash -c "python3 -m venv .venv;source .venv/bin/activate;python -m pip install -r ~/server/tools/requirements.txt; exec bash"
Icon=org.gnome.Terminal
Type=Application
Categories=GNOME;GTK;System;TerminalEmulator;
StartupNotify=true
StartupWMClass=Gnome-terminal
X-GNOME-SingleWindow=false
OnlyShowIn=GNOME;Unity;
Actions=new-window;preferences;
X-Ubuntu-Gettext-Domain=gnome-terminal

[Desktop Action new-window]
Name=new-window
Exec=gnome-terminal --window

[Desktop Action preferences]
Name=Preferences
Exec=gnome-terminal --preferences

XI DB TOOL.desktop

[Desktop Entry]
Name=XI DB TOOL
Comment=Use the command line
Keywords=shell;prompt;command;commandline;cmd;
TryExec=gnome-terminal
Exec=gnome-terminal --window -- bash -c "python3 -m venv .venv;source .venv/bin/activate;cd ~/server/tools;python3 dbtool.py; exec bash"
Icon=org.gnome.Terminal
Type=Application
Categories=GNOME;GTK;System;TerminalEmulator;
StartupNotify=true
StartupWMClass=Gnome-terminal
X-GNOME-SingleWindow=false
OnlyShowIn=GNOME;Unity;
Actions=new-window;preferences;
X-Ubuntu-Gettext-Domain=gnome-terminal

[Desktop Action new-window]
Name=new-window
Exec=gnome-terminal --window

[Desktop Action preferences]
Name=Preferences
Exec=gnome-terminal --preferences

[EDGECOM666]

sorry about that I will post code next time

It didn't rename the shortcut to Install XI DB Tool Requirements.desktop

I can just delete the zip file

[EDGECOM666]

I just tested this on ubuntu 22.04 default install and it works the only thing you need to do is

sudo apt install python3.10-venv

then you can run the requirements shortcut and then launch the dbtools shortcut

I think I can make the install requirements run once then delete its self or move

[EDGECOM666]

I did find away to make it delete the shortcut after installing the requirements

open your preferred text editor and copy paste the code to make the shortcut

[Desktop Entry]
Name=xi_db_tool_req
Comment=Use the command line
Keywords=shell;prompt;command;commandline;cmd;
TryExec=gnome-terminal
Exec=gnome-terminal --window -- bash -c "python3 -m venv .venv;source .venv/bin/activate;python -m pip install -r ~/server/tools/requirements.txt && rm ~/Desktop/xi_db_tool_req.desktop;echo Done Exit in 4 sec;sleep 4;exit; exec bash"
Icon=org.gnome.Terminal
Type=Application
Categories=GNOME;GTK;System;TerminalEmulator;
StartupNotify=true
StartupWMClass=Gnome-terminal
X-GNOME-SingleWindow=false
OnlyShowIn=GNOME;Unity;
Actions=new-window;preferences;
X-Ubuntu-Gettext-Domain=gnome-terminal

[Desktop Action new-window]
Name=new-window
Exec=gnome-terminal --window

[Desktop Action preferences]
Name=Preferences
Exec=gnome-terminal --preferences

save to your desktop as: xi_db_tool_req.desktop

right click -> Allow Launching

double click file you just saved to the desktop