From 5a3d1793e360b020534f006acbef5a1ffc6cd5cc Mon Sep 17 00:00:00 2001 From: Loren Eteval <139033850+LorenEteval@users.noreply.github.com> Date: Sun, 23 Feb 2025 23:29:41 +0800 Subject: [PATCH] Updated Install From PyPI (markdown) --- Install-From-PyPI.md | 54 +++++++++++++++++++++++++++++--------------- 1 file changed, 36 insertions(+), 18 deletions(-) diff --git a/Install-From-PyPI.md b/Install-From-PyPI.md index 6b006c3..8d8bc19 100644 --- a/Install-From-PyPI.md +++ b/Install-From-PyPI.md @@ -1,15 +1,37 @@ -This topic is only recommended for **experienced users** +> [!WARNING] +> This topic is only recommended for **experienced users** --- -If installed via `pip`, Furious will run on native Python. Requires Python 3.8 and above. +> [!NOTE] +> If installed via `pip`, Furious will run on native Python. Requires Python 3.8 and above. -# Core Building Tools +# Install -> Note: These steps are the same in [Xray-core-python](https://github.com/LorenEteval/Xray-core-python) +You have to install GUI and core **seperatedly** from PyPI. + +## Install GUI + +> [!NOTE] +> Install Furious in a Python virtual environment(i.e. venv) is recommended. + +> [!NOTE] +> Furious supports **minimum PySide6 version 6.1.0** since **version 0.2.11**. + +``` +pip install Furious-GUI +``` + +## Install Core + +### Core Building Tools + +> [!NOTE] +> These steps are the same in [Xray-core-python](https://github.com/LorenEteval/Xray-core-python) > or [hysteria2-python](https://github.com/LorenEteval/hysteria2-python) *Core Building Tools* steps. -> Note: Please pay extra attention that upstream projects are dropping build support on go 1.20.x +> [!NOTE] +> Please pay extra attention that upstream projects are dropping build support on go 1.20.x To install Furious via `pip` you must have tools ready for building these bindings for your current platform first. Core building requires: @@ -26,21 +48,17 @@ To install Furious via `pip` you must have tools ready for building these bindin * For Windows users: install [MinGW-w64](https://sourceforge.net/projects/mingw-w64/files/mingw-w64/) or [Cygwin](https://www.cygwin.com/) and make sure you have add them to PATH. -# Install +Supported cores(shipped as Python binding): +* `Xray-core` +* `hysteria`(go1.20 only) +* `hysteria2` +* `tun2socks` -> Note: Install Furious in a Python virtual environment(i.e. venv) is recommended. +``` +pip install Xray-core +``` -> Note: Furious supports **minimum PySide6 version 6.1.0** since **version 0.2.11**. - -Install depending on your **go version**: - -* `pip install Furious-GUI` will install necessary project dependencies, including PySide6, etc. -* `pip install "Furious-GUI[go1.20]"` will install extra: `'Xray-core < 1.8.5', 'hysteria > 1.3.5', 'hysteria2 == 2.0.0.1'` -* `pip install "Furious-GUI[go1.21]"` will install extra: `'Xray-core > 1.8.5', 'hysteria2 > 2.0.4'` - -You can also choose to install requirements seperately. - -# Launch App +# Launch GUI ``` Furious