当我们完成了某一个模块的开发后,可以通过PyPI在网上发布,也可以在本地发布,即让其他人以"第三方扩展库"的方式使用我们的模块。
setuptools是python标准的打包分发工具,它可以将我们编写的python项目打包安装,这样其他人就可以像调用标准库或python第三方库那样直接使用
setuptools是Python distutils的拓展和增强版, 有类似的API和接口
python setup.py develop = pip install -v -e
制作分发自己的包举例
(1条消息) Python使用setuptools打包自己的分发包并使用举例(setup.py)_hxxjxw的博客-CSDN博客
setup.py文件的使用
可以用python setup.py --help-commands 查看相关用法
- python setup.py build #编译
- python setup.py install #安装
- python setup.py sdist #制作分发包,会将要分发的目录打包成tar.gz文件
- python setup.py bdist_wininst #制作windows下的分发包
- python setup.py bdist_rpm
python setup.py build_ext --inplace
给python编译⼀个c、c++的拓展
inplace是忽略build-lib,将编译后的扩展放到源⽬录中,与纯Python模块放在⼀起
setup.py各字段含义
比较全面的写法及解释。required是必须的,optional是非必须的
但是还会有一些没包含的
"""A setuptools based setup module. See: https://packaging.python.org/guides/distributing-packages-using-setuptools/ https://github.com/pypa/sampleproject """ # Always prefer setuptools over distutils from setuptools import setup, find_packages import pathlib here = pathlib.Path(__file__).parent.resolve() # Get the long description from the README file long_description = (here / "README.md").read_text(encoding="utf-8") # Arguments marked as "Required" below must be included for upload to PyPI. # Fields marked as "Optional" may be commented out. setup( # This is the name of your project. The first time you publish this # package, this name will be registered for you. It will determine how # users can install this project, e.g.: # # $ pip install sampleproject # # And where it will live on PyPI: https://pypi.org/project/sampleproject/ # # There are some restrictions on what makes a valid project name # specification here: # https://packaging.python.org/specifications/core-metadata/#name name="sampleproject", # Required # Versions should comply with PEP 440: # https://www.python.org/dev/peps/pep-0440/ # # For a discussion on single-sourcing the version across setup.py and the # project code, see # https://packaging.python.org/guides/single-sourcing-package-version/ version="2.0.0", # Required # This is a one-line description or tagline of what your project does. This # corresponds to the "Summary" metadata field: # https://packaging.python.org/specifications/core-metadata/#summary description="A sample Python project", # Optional # This is an optional longer description of your project that represents # the body of text which users will see when they visit PyPI. # # Often, this is the same as your README, so you can just read it in from # that file directly (as we have already done above) # # This field corresponds to the "Description" metadata field: # https://packaging.python.org/specifications/core-metadata/#description-optional long_description=long_description, # Optional # Denotes that our long_description is in Markdown; valid values are # text/plain, text/x-rst, and text/markdown # # Optional if long_description is written in reStructuredText (rst) but # required for plain-text or Markdown; if unspecified, "applications should # attempt to render [the long_description] as text/x-rst; charset=UTF-8 and # fall back to text/plain if it is not valid rst" (see link below) # # This field corresponds to the "Description-Content-Type" metadata field: # https://packaging.python.org/specifications/core-metadata/#description-content-type-optional long_description_content_type="text/markdown", # Optional (see note above) # This should be a valid link to your project's main homepage. # # This field corresponds to the "Home-Page" metadata field: # https://packaging.python.org/specifications/core-metadata/#home-page-optional url="https://github.com/pypa/sampleproject", # Optional # This should be your name or the name of the organization which owns the # project. author="A. Random Developer", # Optional # This should be a valid email address corresponding to the author listed # above. author_email="author@example.com", # Optional # Classifiers help users find your project by categorizing it. # # For a list of valid classifiers, see https://pypi.org/classifiers/ classifiers=[ # Optional # How mature is this project? Common values are # 3 - Alpha # 4 - Beta # 5 - Production/Stable "Development Status :: 3 - Alpha", # Indicate who your project is intended for "Intended Audience :: Developers", "Topic :: Software Development :: Build Tools", # Pick your license as you wish "License :: OSI Approved :: MIT License", # Specify the Python versions you support here. In particular, ensure # that you indicate you support Python 3. These classifiers are *not* # checked by 'pip install'. See instead 'python_requires' below. "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3 :: Only", ], # This field adds keywords for your project which will appear on the # project page. What does your project relate to? # # Note that this is a list of additional keywords, separated # by commas, to be used to assist searching for the distribution in a # larger catalog. keywords="sample, setuptools, development", # Optional # When your source code is in a subdirectory under the project root, e.g. # `src/`, it is necessary to specify the `package_dir` argument. package_dir={"": "src"}, # Optional # You can just specify package directories manually here if your project is # simple. Or you can use find_packages(). # # Alternatively, if you just want to distribute a single Python file, use # the `py_modules` argument instead as follows, which will expect a file # called `my_module.py` to exist: # # py_modules=["my_module"], # packages=find_packages(where="src"), # Required # Specify which Python versions you support. In contrast to the # 'Programming Language' classifiers above, 'pip install' will check this # and refuse to install the project if the version does not match. See # https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires python_requires=">=3.7, <4", # Optional # This field lists other packages that your project depends on to run. # Any package you put here will be installed by pip when your project is # installed, so they must be valid existing projects. # # For an analysis of "install_requires" vs pip's requirements files see: # https://packaging.python.org/discussions/install-requires-vs-requirements/ install_requires=["peppercorn"], # Optional # List additional groups of dependencies here (e.g. development # dependencies). Users will be able to install these using the "extras" # syntax, for example: # # $ pip install sampleproject[dev] # # Similar to `install_requires` above, these must be valid existing # projects. extras_require={ # Optional "dev": ["check-manifest"], "test": ["coverage"], }, # If there are data files included in your packages that need to be # installed, specify them here. package_data={ # Optional "sample": ["package_data.dat"], }, # Although 'package_data' is the preferred approach, in some case you may # need to place data files outside of your packages. See: # http://docs.python.org/distutils/setupscript.html#installing-additional-files # # In this case, 'data_file' will be installed into '<sys.prefix>/my_data' data_files=[("my_data", ["data/data_file"])], # Optional # To provide executable scripts, use entry points in preference to the # "scripts" keyword. Entry points provide cross-platform support and allow # `pip` to create the appropriate form of executable for the target # platform. # # For example, the following would provide a command called `sample` which # executes the function `main` from this package when invoked: entry_points={ # Optional "console_scripts": [ "sample=sample:main", ], }, # List additional URLs that are relevant to your project as a dict. # # This field corresponds to the "Project-URL" metadata fields: # https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use # # Examples listed include a pattern for specifying where the package tracks # issues, where the source is hosted, where to say thanks to the package # maintainers, and where to support the project financially. The key is # what's used to render the link text on PyPI. project_urls={ # Optional "Bug Reports": "https://github.com/pypa/sampleproject/issues", "Funding": "https://donate.pypi.org", "Say Thanks!": "http://saythanks.io/to/example", "Source": "https://github.com/pypa/sampleproject/", }, )
所以,最简化的写法
import setuptools #定义包的一些属性 setuptools.setup( name='hxx_learn', version='1.0', packages = setuptools.find_packages('./'), )
可以使用
python setup.py check
检查
setup.py
文件是否有错误
字段含义
- name:包名称.
- version (-V):包版本
- url:程序的官网地址
- description:程序的简单描述
- packages:需要处理的包目录(包含__init__.py的文件夹)
- py_modules:需要打包的python文件列表
- data_files:打包时需要打包的数据文件,如图片,配置文件等
- scripts:安装时需要执行的脚步列表
- package_dir:告诉setuptools哪些目录下的文件被映射到哪个源码包
- requires:定义依赖哪些模块
- entry_points:控制命令的
- find_packages() 默认在和setup.py同一目录下搜索各个含有 __init__.py的包。如果有多个含有 __init__.py的包,会都打包到一起。
zip_safe
等于False的话,不压缩包,而是以目录的形式安装
zip_safe=False命令生成的egg-info
zip_safe=True命令生成的egg-info
如果想获得最佳性能那应该设为True,但不是所有程序都能压缩成zip
install_requires
install_requires的话就是比如你发布的包里用了一些模块,那么你发布的时候就要写上
例如你发布的模块的代码里import opencv, 那么你发布的时候就要写上
install_requires=["opencv"]
ext_modules
ext_modules
参数用于构建 C 和 C++ 扩展扩展包
Python模块的本地发布 setuptools(setup.py)(包管理工具)(distutils)
于 2021-04-29 18:03:49 首次发布