packaging python project

學(xué)習(xí)過程中參考網(wǎng)站https://packaging.python.org/tutorials/packaging-projects/展懈,主要是翻譯成中文。

  • 在本地建立項(xiàng)目的時(shí)候钞它,首先需要?jiǎng)?chuàng)建如下的文件結(jié)構(gòu):
packaging_tutorial/
  example_pkg/
    __init__.py

接下來所有的操作都是在packaging_tutorial文件夾下面

  • 創(chuàng)建打包的文件
packaging_tutorial/
  example_pkg/
    __init__.py
  setup.py
  LICENSE
  README.md
  • setup.py
    該文件的作用是setuptools的build script.他傳遞給setuptools關(guān)于你的包的名字薄腻,版本等信息等思瘟。
import setuptools

with open("README.md", "r") as fh:
    long_description = fh.read()

setuptools.setup(
    name="example-pkg-YOUR-USERNAME-HERE", # Replace with your own username
    version="0.0.1",
    author="Example Author",
    author_email="author@example.com",
    description="A small example package",
    long_description=long_description,
    long_description_content_type="text/markdown",
    url="https://github.com/pypa/sampleproject",
    packages=setuptools.find_packages(),
    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
    python_requires='>=3.6',
)
  • README.md
# Example Package

This is a simple example package. You can use
[Github-flavored Markdown](https://guides.github.com/features/mastering-markdown/)
to write your content.
  • LICENSE
    https://choosealicense.com/

  • 生成distribution archives
    這樣的話就可以使用pip進(jìn)行安裝了喂击;

    1. 確保自己有最新的setuptoolswheel安裝:
python3 -m pip install --user --upgrade setuptools wheel
  1. 在setup.py所在的文件夾運(yùn)行如下代碼:
 python3 setup.py sdist bdist_wheel

最終應(yīng)該輸出一些文字肃叶,一旦成功在dist文件夾會生成兩個(gè)文件:

dist/      
example_pkg_YOUR_USERNAME_HERE-0.0.1-py3-none-any.whl
example_pkg_YOUR_USERNAME_HERE-0.0.1.tar.gz
 python3 -m pip install --user --upgrade twine
  1. 一旦安裝完畢劝评,可以使用一下代碼上傳所有的在dist的archives:
python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
  1. username: token
    password: pypi- prefix
    最終可以看到類似的內(nèi)容:
  Uploading distributions to https://test.pypi.org/legacy/
Enter your username: [your username]
Enter your password:
Uploading example_pkg_YOUR_USERNAME_HERE-0.0.1-py3-none-any.whl
100%|█████████████████████| 4.65k/4.65k [00:01<00:00, 2.88kB/s]
Uploading example_pkg_YOUR_USERNAME_HERE-0.0.1.tar.gz
100%|█████████████████████| 4.25k/4.25k [00:01<00:00, 3.05kB/s]
  1. 可以再網(wǎng)頁上看到自己的package:https://test.pypi.org/project/example-pkg-YOUR-USERNAME-HERE
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末姐直,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子蒋畜,更是在濱河造成了極大的恐慌声畏,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,270評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件百侧,死亡現(xiàn)場離奇詭異砰识,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)佣渴,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,489評論 3 395
  • 文/潘曉璐 我一進(jìn)店門辫狼,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人辛润,你說我怎么就攤上這事膨处。” “怎么了砂竖?”我有些...
    開封第一講書人閱讀 165,630評論 0 356
  • 文/不壞的土叔 我叫張陵真椿,是天一觀的道長。 經(jīng)常有香客問我乎澄,道長突硝,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,906評論 1 295
  • 正文 為了忘掉前任置济,我火速辦了婚禮解恰,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘浙于。我一直安慰自己护盈,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,928評論 6 392
  • 文/花漫 我一把揭開白布羞酗。 她就那樣靜靜地躺著腐宋,像睡著了一般。 火紅的嫁衣襯著肌膚如雪檀轨。 梳的紋絲不亂的頭發(fā)上胸竞,一...
    開封第一講書人閱讀 51,718評論 1 305
  • 那天,我揣著相機(jī)與錄音裤园,去河邊找鬼撤师。 笑死,一個(gè)胖子當(dāng)著我的面吹牛拧揽,可吹牛的內(nèi)容都是我干的剃盾。 我是一名探鬼主播腺占,決...
    沈念sama閱讀 40,442評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼痒谴!你這毒婦竟也來了衰伯?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,345評論 0 276
  • 序言:老撾萬榮一對情侶失蹤积蔚,失蹤者是張志新(化名)和其女友劉穎意鲸,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體尽爆,經(jīng)...
    沈念sama閱讀 45,802評論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡怎顾,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,984評論 3 337
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了漱贱。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片槐雾。...
    茶點(diǎn)故事閱讀 40,117評論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖幅狮,靈堂內(nèi)的尸體忽然破棺而出募强,到底是詐尸還是另有隱情,我是刑警寧澤崇摄,帶...
    沈念sama閱讀 35,810評論 5 346
  • 正文 年R本政府宣布擎值,位于F島的核電站,受9級特大地震影響逐抑,放射性物質(zhì)發(fā)生泄漏鸠儿。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,462評論 3 331
  • 文/蒙蒙 一厕氨、第九天 我趴在偏房一處隱蔽的房頂上張望捆交。 院中可真熱鬧,春花似錦腐巢、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,011評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至遭京,卻和暖如春胃惜,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背哪雕。 一陣腳步聲響...
    開封第一講書人閱讀 33,139評論 1 272
  • 我被黑心中介騙來泰國打工船殉, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人斯嚎。 一個(gè)月前我還...
    沈念sama閱讀 48,377評論 3 373
  • 正文 我出身青樓利虫,卻偏偏與公主長得像挨厚,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子糠惫,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,060評論 2 355

推薦閱讀更多精彩內(nèi)容