PyCharm+Vagrant+Django搭建过程完整版

python开发环境依赖的问题，非常影响团队效率。
接下来的文档介绍我们现在团队使用的Pycharm+Vagrant部署开发环境的方式。

食用好处：

• 环境配置简单方便
• 搭建好了之后，方便团队复用，真团队开发的好帮手

以下流程基于的搭建环境：
OS：Win10
Pycharm：2019.2.4

1.下载软件

1.1 Pycharm

1.1.1 Pycharm v2019.2.4安装成功后，不要打开软件，然后将激活补丁“jetbrains-agent.jar”放在 Pycharm的bin路径下。

1.1.2 打开 pycharm64.exe.vmoptions 后，如下图：
如果是默认安装的，在文档的最后面加上：
-javaagent:C:\Program Files\JetBrains\PyCharm 2019.2.4\bin\jetbrains-agent.jar
如果不是，则填pycharm64.exe所在位置，然后[Ctrl + S]保存文件

1.1.3 Pycharm已注册

1.2 Virtualbox

免费又轻量的虚拟化软件
下载最新版安装即可

1.3 Vagrant

1.3.1 安装最新版本Vagrant
Vagrant下载地址

成功安装：命令行输入vagrant -v，输出vagrant版本信息，输出其他信息，则失败

1.3.2 下载CentOS7镜像：CentOS-7-x86_64-Vagrant-1907_01.VirtualBox.box

• 下载box文件：CentOS-7-x86_64-Vagrant-1907_01.VirtualBox.box国内源下载地址
• 命令行进入下载文件夹
• vagrant box add BoxName CentOS-7-x86_64-Vagrant-1907_01.VirtualBox.box

BoxName 为自定义镜像名字，这里我设定的名字为centos7

Vargant的使用参考：Vargrant Docs

2. 初始化项目

2.1 初始化生成Vagrantfile

• Tools->Vagrant->Init in Project Root
  
• 在Pycharm弹框中选择刚添加的BoxName，此时项目根目录下会出现一个名叫Vagrantfile的配置文件
• 修改Vagrantfile

#对应`Vagrant`添加的box，即1.3.2 中设置的`BoxName`
config.vm.box = "centos7"  
#通过端口映射来访问Vagrant内的Django开发服务器
#将本机的80端口映射到虚拟机的8080端口
config.vm.network "forwarded_port", guest: 8080, host: 80, host_ip: "192.168.5.99"

#设置同步目录和排除文件规则
config.vm.synced_folder "../neo-plateform", "/vagrant_data"
rsync__verbose = true,
rsync__exclude = ['.git*', 'node_modules*','*.log','*.box','Vagrantfile']

#安装软件和修改配置
  config.vm.provision "shell", inline: <<-SHELL
    sudo yum install -y python36 python36-devel python36-pip \
    libtiff-devel libjpeg-devel libzip-devel freetype-devel \
    lcms2-devel libwebp-devel tcl-devel tk-devel sshpass \
    openldap-devel mariadb-devel mysql-devel libffi-devel \
    openssh-clients telnet openldap-clients gcc
    
    mkdir /root/.pip
    cat << EOF | sudo tee /root/.pip/pip.conf
    [global]
    timeout = 6000
    index-url = https://mirrors.aliyun.com/pypi/simple/

    [install]
    use-mirrors = true
    mirrors = https://mirrors.aliyun.com/pypi/simple/
    trusted-host=mirrors.aliyun.com

#注意，EOF前面必须没有空格 
EOF

    mkdir /home/vagrant/.pip
    cat << EOF | sudo tee /home/vagrant/.pip/pip.conf
    [global]
    timeout = 6000
    index-url = https://mirrors.aliyun.com/pypi/simple/
    
    [install]
    use-mirrors = true
    mirrors = https://mirrors.aliyun.com/pypi/simple/
    trusted-host=mirrors.aliyun.com

EOF
SHELL

Vagrantfile官方说明文档

• 由于vagrant同步文件夹有bug，不能实时同步，所以每次虚拟机重启之前，都需要确认一下配置
  打开位于项目文件夹下的.vagrant/machines/default/virtualbox/synced_fllders文件
  
  确认virtualbox对应的value里“/vagrant”都改为了“/vagrant_data”,

• 启动Vagrant
  
  启动成功之后可以在VirtualBox里看到
  

• 连接到Vagrant虚拟机
  

• 测试修改文件后，是否同步成功
  测试D:/HRG/GitDevops/neo-plateform修改后，/vagrant_data是否改变
  测试/vagrant_data修改后，D:/HRG/GitDevops/neo-plateform是否改变

• 选择当前目录下的地址，进入虚拟机

• 安装依赖库
  进入/vagrant_data，执行pip3 install –r requirements.txt
  

• Pycharn切换python解释器至Vagrant虚拟机内的解释器
  File -> Settings -> Project YourProjectName -> Project Interpreter -> Add -> Vagrant -> Vagrant Instance Fold && Python interpreter path

Vagrant选项中的python路径设置到Vagrant虚拟机内python3.6二进制的全路径

至此开发环境搭建完成

3. 运行Django web服务器

• 3.1 修改运行配置，运行的host地址为0.0.0.0， 端口为8080，并且确保使用了vagrant虚拟机内的python解释器
  
• 3.2 保证端口转发设置正确
  确保Vagrantfile的host配置和3.1中配置一致

config.vm.network "forwarded_port", guest: 8080, host: 8080, host_ip: "192.168.5.99"

• 3.3 启动Vagrant
  已经启动过了的，不需要重新启动
  

• 3.4 运行django web 服务器
  
  或者
  

• 3.5启动成功之后，在本机上调用地址+端口即可访问Django程序

4. 使用

在这样的一个环境下，你新建的所有 Python 项目文件，都会被同步到 Vagrant 虚拟机中的 /vagrant_data/ 目录下，你在本地运行 Python 项目，其实都是在 Vagrant 虚拟机中运行。

如果你的 Python 项目运行需要依赖很多的组件 ，那完全可以将这些组件全部安装在这个 Vagrant 虚拟机中，打包成镜像，然后把这个镜像和项目（包括 .vagrant 文件夹 和 Vagrantfile）发给你的同事，他们就能很快的也拥有一套可以稳定运行的项目运行环境。

5.常见问题和解决方案

• pip安装依赖库失败：检查pip是否最新，不是则更新pip
• Django在Vagrant虚拟环境里正常启动，但无法在本机里调用接口：检查Vagrantfile中的端口映射是否正确

附录：

中国大陆开源镜像站汇总

Pycharm+Vagrant安装包百度云下载链接
提取码：x3x2