1 问题
最近在写一些爬虫相关的项目,发现其中有很多的操作都是一些重复的代码,且有一定的规律性,所以就决定自己写一个自定义的包(packagea
),然后通过from moudle import moudle
的方式导入,就可以省去很多麻烦了。
但是发现,只有在pycharm
中才可以导入自己的自定义包,如果在命令行中运行python
文件的话,就会提示找不到,Google
之后发现,是因为自己写的包没有添加到python
的环境变量中。我们可以通过下面的语句查看环境变量:
import sys
print(sys.path) ## 查看环境变量
sys.path.append(r"c/mypackage/") ## 将自己的包添加到环境变量中
看了上面的代码之后,我们可以发现,我们可以将自己的自定义包添加到python
环境变量,但是我们每次都需要使用sys
包,进行append
我们自己的包路径。很是麻烦。今天介绍一种非常一次性解决的方法,直接将我们的包拷贝一份到环境变量中。
2 解决问题
我们可以使用python
中的setuptools
包,将我们的包自动拷贝到python
环境变量中。目录结构参考如下:
第一步 如何配置
在我们的自定义的包,添加一个python
文件,且该文件必须命名为:setup.py
,然后在该文件中,写上一些具体的参数即可。
# coding=utf-8
from setuptools import setup
setup(
author="CrazyJUms", ### 作者的名字 也就是你自己的名字
author_email ="15959963313@163.com", ### 作者的邮箱
description="This is a utility, writen by CrazyJUms", ### 一句话概括一下
url="https://github.com/crazyjums/my_utility", ### 你可以把你的home page或者github主页的地址写上
name="utility", ### 给你的包取一个名字
version="1.0", ### 你的包的版本号
packages=['utility'], ### 这里写的是需要从哪个文件夹下导入python包,目录结构如上面所示,名字必须对上,如果找不到会报错
install_requires=[ ### 这是你的自定义包中已经导入的一些三方包,这里填上,当自动安装的时候,就会监测本地电脑是否安装,如果没有安装会自动联网按住那个非常方便
"requests>=2.23.0",
"bs4>=0.0.1",
"lxml>=4.5.0"
],
exclude_package_date={'':['.gitignore'], '':['dist'], '':'build', '':'utility.egg.info'}, ### 这是需要排除的文件,也就是只把有用的python文件导入到环境变量中
)
这里只介绍一些基本的参数,具体的所有参数,请参考setuptools官网。
第二步 如何使用
我们有两种方式可以在本地运行,这两种方法的前提都是得进入到你的包的目录中:
- 方法一:使用
python setup.py install
进行安装 - 方法二:使用
pip install .
进行安装,注意:有一个点,别忘了,代表当前目录
第三步 如何联网安装
当然,如果你不满足于本地,希望将自己的包给全世界的程序员使用,那么你可以将自己的上传至PYPI,这样的话,我们就可以直接使用pip install your-package-name
进行联网安装了,并不需要进入到你的目录里面。
首先你得在PYPI注册一个装好,然后按照里面的步骤,提交你的代码压缩包即可。提交的是一个后缀为.tar.gz
的压缩包,你可以使用命令python setup.py sdist
进行生成。
然后你可以看到你的目录下面多了一个dist
的目录,该目录下面有一个压缩包,你将此压缩包上传至PYPI,就可以了。
上传命令:
python setup sdist uplaod
然后你就可以使用pip
进行安装了。