Python 包的创建
1.创建一个GitHub仓库
在 https://github.com 网站创建即可
2.将代码 clone 到本地
git clone https://github.com/yourname/packagename.git
cd packagename
3.创建 setup.py
文件 ,文件内容应该类似下面这个样子:
from os import path as os_path
from setuptools import setup, find_packages
this_directory = os_path.abspath(os_path.dirname(__file__))
# 读取文件内容
def read_file(filename):
with open(os_path.join(this_directory, filename), encoding='utf-8') as f:
long_description = f.read()
return long_description
# 获取依赖
def read_requirements(filename):
return [line.strip() for line in read_file(filename).splitlines()
if not line.startswith('#')]
setup(
name='itxq_workflow', # 包名
python_requires='>=3.7.0', # python环境
version='1.0.0', # 包的版本
description="这里是包的简介", # 包简介,显示在PyPI上
long_description=read_file('README.md'), # 读取的Readme文档内容
long_description_content_type="text/markdown", # 指定包文档格式为markdown
author="IT小强xqitw.cn", # 作者相关信息
author_email='mail@xqitw.cn',
url='https://github.com/itxq/workflow-python',
# 指定包信息,还可以用find_packages()函数
packages=find_packages(),
install_requires=read_requirements('requirements.txt'), # 指定需要安装的依赖
include_package_data=True,
license="MIT",
keywords=['关键词', '关键词2', '关键词23'],
classifiers=[
'Intended Audience :: Developers',
'License :: OSI Approved :: MIT License',
'Natural Language :: English',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
],
)
4.创建项目包文件,创建后,整个项目目录结构应该类似于下面这个样子:
.
├── packagename
│ ├── __init__.py
│ ├── a.py
│ └── b.py
├── LICENSE
├── README.md
└── setup.py
setup.py
会自动查找项目根目录下,包含文件 __init__.py 的子目录,作为项目的包,并以目录名称作为包名。当然不是必须创建一个同名的包,事实上,可以创建任意名称的多个包。
5.生成源码分发包
python setup.py sdist
运行该命令之后,会生成一个haipproxy.egg-info文件夹,可以查看其中的SOURCES.txt文件,以确定是否所有需要的内容都已经被包括在待发布的包中
本作品采用《CC 协议》,转载必须注明作者和本文链接
干货呀