Skip to content

install.md

Latest commit

 

History

History
61 lines (40 loc) · 1.61 KB

install.md

File metadata and controls

61 lines (40 loc) · 1.61 KB

Installation

Creating a Virtual Environment

  • The current framework only supports MacOS and Linux on X86 architecture.
  • Tested only with Python 3.8.

Install Miniconda:

wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh
sh Miniconda3-latest-Linux-x86_64.sh

Create a virtual environment:

conda create -n pfs python=3.8
source activate pfs

Installing via Pip (Recommended)

pip install python-fast-service

Installing from Source

  • First, clone the source code:
git clone https://github.com/cactusgame/python-fast-service.git
  • Recommended installation: navigate to the root directory and enter the following command:
    • For future framework upgrades, simply git pull the latest code without reinstalling.
    • Only this installation method allows full functionality of the abt tool.
pip install -e .

Offline Installation

  • In some cases, the server may be unable to connect to the network. You can first download the zip package of a specific tag on a machine with internet access and then install it offline using pip.
pip install pfs-xxxx.tar.gz

If you need to perform an offline installation within a Dockerfile, copy the .tar.gz package into the Docker container before executing the installation. For example:

COPY ./setup/pfs-xxxx.tar.gz ./pfs-xxxx.tar.gz

Dependencies

  • To use the file and logs commands in abt, you need to install ossutil separately. Follow the OSS documentation for installation instructions.