pypa / pypa/packaging.python.org
Packaging instructions are not optimal about README.MD
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 1.7k
- フォーク
- 1.7k
- 平均マージ
- 3日 12時間
- マージ済み PR(30日)
- 4
説明
Thank you for providing feedback on Python packaging!
To help us help you, please fill out as much of the following as you can. If a question is not relevant, feel free to skip it.
- What is your operating system and version?
MacOS 10.15.3
- What is your Python version?
Python 3.7.3
- What version of pip do you have?
pip 19.0.3
- If following an online tutorial or guide, please provide a link to the page or section giving you trouble:
https://packaging.python.org/tutorials/packaging-projects/#creating-setup-py
- Could you describe your issue in as much detail as possible?
The instructions provide an adagio for a long readme and claim it is normal:
with open("README.md", "r") as fh:
long_description = fh.read()
This however, will only run from the directory containing this file. It is better to construct a path:
here = path.dirname (path.realpath (__file__))
readme = open (path.join (here, 'README.MD')).read ()
Both forms still leave a problem. When setup.py is run during pip install, it will try to open README.md once more, while it is being installed. (This was after uploading an sdist, not a bdist.)
Collecting arpa2.wsgi
Downloading https://files.pythonhosted.org/packages/71/87/fe38499da24d4bfcd04d301aa20a03af35bfdf379e8b739069b8a726af2a/arpa2.wsgi-0.4.0.tar.gz
Complete output from command python setup.py egg_info:
Traceback (most recent call last):
File "<string>", line 1, in <module>
File "/private/var/folders/5_/dsls_kvx7tq171bf6chfm3x80000gn/T/pip-install-zcq3d6v9/arpa2.wsgi/setup.py", line 19, in <module>
readme = open (path.join (here, 'README.MD')).read ()
FileNotFoundError: [Errno 2] No such file or directory: '/private/var/folders/5_/dsls_kvx7tq171bf6chfm3x80000gn/T/pip-install-zcq3d6v9/arpa2.wsgi/README.MD'
As far as I can see, I am not supposed to include the README.MD and it is only needed because of the packaging instruction -- which may be off. Not sure what a good fix would be, otherwise I'd suggest it.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Packaging User Guide の「Packaging Python Projects」チュートリアルの「Creating setup.py」セクションから始め、報告されている sdist のインストール失敗に照らして README の例を確認します。README がどのように含まれるかを手順で正確に説明でき、報告されている FileNotFoundError が発生せずに手順に従える状態になれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 42/100