AIDROID

Subtitle

0%

python创建自己的package

Posted on Edited on In , Views: Valine:

原文链接：python创建自己的package

python创建自己的package

package介绍

Python 包是提供一些附加功能的 Python 模块的目录。
包允许您将代码组织到单独的文件和文件夹中，并在需要的地方导入它们，使您的代码保持简洁

模块结构

1
2
3
4
5
6
7
8
9
10
11
12
13
14
\-packagedemo
  \-packagename
    -1.py
    -2.py
    \-dir
      -__init.py
      -3.py
      -...
    -...
    -__init__.py
  -__init__.py
  -LICIENSE
  -README.MD
  -setup.py

说明

  1. package项目和setup/LICIENSE/README.MD同级
  2. packagename项目下的文件可以是任意的，但是每一个包含源码的目录下需要有__init__.py
  3. init.py可以写入该文件夹下的同级源码文件名称 all=[‘1’,’2’]
  4. 项目内import要从packagename开始

setup编写

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
from setuptools import Extension, dist, find_packages, setup
import os
BASE_DIR = os.path.abspath(os.path.dirname(__file__))
with open("README.MD", "r") as fh:
    long_description = fh.read()

setup(
    name='packagename',
    version="X.X.X",
    description='packagename',
    long_description=long_description,
    long_description_content_type="text/markdown",
    keywords='data analysis',
    url='https://github.com/XX/packagename',
    author='author',
    author_email='XXXX.com@gmail.com',
    # packages=find_packages(),

    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],

    setup_requires=['pytest-runner'],
    tests_require=['pytest'],

    python_requires = '>=3.6',
    install_requires=[
        'pandas>=2.0.0',
        'scikit-learn>=1.0.0',
        'numpy>=1.24.0',
        'matplotlib>=3.7.0'
    ],

    # entry_points={
    #     'console_scripts': [
    #         'foo = foo.main:main'
    #     ]
    # },
    # scripts=['bin/foo.sh', 'bar.py'],


)

项目打包

  1. 检查setup是否正确
    1
    python setup.py check
  2. 创建gz的安装包
    1
    python setup.py sdist
    会在setup.py同级下生成dist文件夹，里面包括了packagename-X.X.X.tar.gz
    可用通过pip安装
    3.创建wheel安装包 需要安装wheel包
    1
    python setup.py sdist bdist_wheel
    dist下生成packagename-X.X.X.py3-none-any.whl

项目发布

使用twine上传

1
python -m twine upload --repository pypi dist/*

输入pypi的账户和密码即可，由于网络原因会存在无法上传或出错，多重复几次即可

项目测试

使用pypi安装项目
可以发布到testpypi，进行测试，testpypi会更快

1
2
pip install -i https://pypi.org/simple packagename==X.X.X
pip install -i https://test.pypi.org/simple packagename==X.X.X