Skip to content

Latest commit

 

History

History
121 lines (95 loc) · 4.56 KB

README_CN.md

File metadata and controls

121 lines (95 loc) · 4.56 KB
Raw

env_installer

Support Python Version License Open Source Love

English

env_installer是一个对于python项目的在线打包和离线安装的工具。

说明

  • 此工具基于pip和virtualenv。 因此, 你的项目必须符合pip工作流, 即你的项目必须包含一个类似于requirements.txt的记录项目依赖的文件。
  • 只支持python3和linux系统。

快速开始

首先克隆env_installer到本地(任意路径,最好在你的家目录下)。

假设这是你即将准备部署的项目(位于/home/DemoProject):

DemoProject
├──assets
├──library
├──local
├──settings
├──temp
└──requirements.txt

打包

usage: pack.py [-h] -b BASE_DIR -r REQ_DIR [-d DOWNLOAD_DIR] [-v]
               [-i INDEX_URL]

arguments:
  -b BASE_DIR, --base-dir BASE_DIR
                        absolute path of the project to be packaged.
  -r REQ_DIR, --req-dir REQ_DIR
                        absolute path of production environment dependency
                        file.
  -d DOWNLOAD_DIR, --download_dir DOWNLOAD_DIR
                        absolute path of package storage location.
  -v                    if need to download an additional `virtualenv`
                        package, use this param. default false.
  -i INDEX_URL, --index-url INDEX_URL
                        download package index url, equivalent to `pip install
                        -i`.

此时你的项目的绝对路径是: /home/DemoProject

依赖文件的绝对路径是: /home/DemoProject/requirements.txt

如果服务器上还没有安装virutalenv,则加上-v参数，env_installer会为你额外下载它的安装包。

如果默认的pip源下载速度慢，你可以用-i更换它，就像pip install -i 那样。

到这里，我们的打包命令就完成了:

python3 pack.py -b /home/DemoProject -r /home/DemoProject/requirements.txt -v

这会在你的项目下生成一个目录,里面存储的是按照requirements.txt列出的依赖的whl格式的安装包。

你不必关心这个目录的名字，因为env_installer会处理好一切!

运行成功结果:

Packaged successfully! Saved /home/DemoProject/ea385f6cb21d4097

安装

usage: install.py [-h] -b BASE_DIR -r REQ_DIR [--venv-pip-path VENV_PIP_PATH]
                  [-p PYTHON]

arguments:
  -b BASE_DIR, --base-dir BASE_DIR
                        absolute path of the project to be deployed.
  -r REQ_DIR, --req-dir REQ_DIR
                        absolute path of production environment dependency
                        file.
  --venv-pip-path VENV_PIP_PATH
                        the pip absolute path of the virtual environment that
                        already exists on the server.
  -p PYTHON, --python PYTHON
                        python interpreter path on the server.equivalent to
                        `virtualenv -p`.

现在我们切换到服务器上,确保假设你已经将打包后的项目上传到了服务器的/deploy/DemoProject,并且服务器上面已经安装好了python3(/usr/bin/python3)。

the absolute path of your project:

/deploy/DemoProject

the absolute path of dependent file:

/deploy/DemoProject/requirements.txt

如果你在打包时使用了-v参数，则env_installer认为你要在服务器上安装virtualenv, 那么忽略--venv-pip-path参数，给出-p, python3解释器的路径用于安装好virtualenv之后创建虚拟环境。 相反，如果你的服务器上已经准备好了一个virtualenv，那么你只需要给出已经存在的virtualenv下的pip路径即可,例如:/deploy/ae0719f3_venv/bin/pip3.

到这里，我们的安装命令就完成了:

python3 install.py -b /deploy/DemoProject -r /deploy/DemoProject/requirements.txt -p /usr/bin/python3

需要注意的是，此时因为需要在服务器上安装virtualenv，因此需要Root权限，命令执行中途会要求你输入正确的root密码.

运行成功结果:

installed successfully!now you can run:
 source /deploy/DemoProject/6195b07d_venv/bin/activate
to activate the virtualenv.