pypi如何將自己的包開源?
阿新 • • 發佈:2018-12-07
要想將自己的包開源得先準備材料:
先解釋下這個檔案中檔案的由來:
1.loggingtool這是一個包(切記包,也就是說裡面必須有__init__.py檔案),這個包是你要開源的包,也就是開發者自己寫的Python程式碼,這是基礎哈
2.setup.py這是用於生成圖中dist和loggingtool.egg-info這個兩個資料夾的,其中dist裡面會是一個開源的壓縮包
先展示下setup.py這個檔案的內容:
#!/usr/bin/env python
# _*_ coding:utf-8 _*_
"""
File: LogTool.py
Author: Lijiacai ( [email protected])
Date: 2018-11-20
Description:
setup tool
"""
import os
import sys
cur_dir = os.path.split(os.path.realpath(__file__))[0]
sys.path.append("%s/" % cur_dir)
from setuptools import setup
from setuptools import find_packages
setup(
name="loggingtool", # 這裡是pip 專案名稱
version="18.11.22", # 釋出的版本號,如果更新改庫,那麼會優先下載數值大的
keywords=("pip", "logging", "loggingtool"), # 搜尋關鍵字
description="The package for logging",
long_description="The package uses the dictionary method of " +
"logging module to achieve log rollback and other output.",
license="MIT License", # 這個可以不要哈
url="https://github.com/lijiacaigit/LogTool", # 這個是pip上的homepage,就是你原始碼的位置
author="Lijiacai", # 作者
author_email=" [email protected]",
packages=find_packages(),
include_package_data=True,
platforms="any",
install_requires=["logging"] # 這個專案需要的第三方庫
)
執行Python setup.py sdist就可以生成dist loggingtool.egg-info檔案夾了
3.將打包好的檔案上傳至pypi
這裡需要大家自行去註冊pypi賬號,上傳過程中需要輸入賬號和密碼
工具:twine
pip install twine
使用命令列:
twine upload dist/loggingtool-18.11.22.tar.gz
上傳過程中需要輸入賬號密碼喲
4.下載上傳成功的包
pip install loggingtool
然後就能使用這個第三方庫了,別人也能用!!!
5.相關資訊
一般釋出pip專案,都會在github上配置檔案用來方便讀者看原始碼,比如我的:
github地址