わずか 3 つの簡単なステップで Python パッケージを公開するために必要な究極のガイド


setup.py スクリプトの代わりに詩を使用した への返信.

手順のみに焦点を当てます.より適切で完全な article here を読むことができます.

すべてのものをインストールする



Python と詩がインストールされていると仮定していますが、インストールされていない場合は install です.

1.パッケージを作成する




$ poetry new sample-package
Created package sample-package in sample-package


これにより、プロジェクトのレイアウトが作成されます.

sample-package/
├── sample-package/
│   └── __init__.py
├── tests/
│   ├── __init__.py
│   └── test_sample-package.py
├── pyproject.toml
└── README.rst 


2. pyproject.toml にパッケージを記述します



ここで、パッケージが何をするかを説明し、依存関係を定義します.

例えば:

[tool.poetry]
name = "sample-package"
version = "0.0.1"
description = "Sample Description for your sample file"
authors = ["John Doe <[email protected]>"]

[tool.poetry.dependencies]
# Updated Python version
python = "^3.6"

[tool.poetry.dev-dependencies]
pytest = "^3.0"

[build-system]
requires = ["poetry>=0.12"]
build-backend = "poetry.masonry.api"


X. パッケージを書く



空のパッケージを公開する理由はありません.何かを行うことを確認してください.

3.公開しよう!



パッケージが機能し、すべてのテストに合格した後、世界中で利用できるようにしたい場合は、次をビルドします.

$ poetry build


TestPyPi による公開のテスト



これはオプションですが、強くお勧めします.

Test PyPi をパッケージ リポジトリとして追加する

$ poetry config repositories.testpypi https://test.pypi.org/legacy/


テスト PyPi に公開します.

$ poetry publish -r testpypi


Test PyPi からインストールする

pip install --index-url https://test.pypi.org/simple/ flake8-markdown


本当に公開して



すべてが良好で、公開する準備ができている場合:

poetry publish


ノート


  • 詩が初めての場合は、read the docs
  • Test PyPi および PyPi のアカウントが必要です.register を持っていない場合は