pypa / pypa/packaging.python.org

Articulate distinction between "library" and "application" projects

オープン
#100 コメント 13 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Python
スター
1.7k
フォーク
1.7k
平均マージ
3日 12時間
マージ済み PR(30日)
4

説明

There is a distinction between "library" projects and "application" projects that I only recently became more clearly and consciously aware of. For example, see: http://www.fullstackpython.com/application-dependencies.html

The installation and distribution procedures in these two cases are somewhat different. For example, on the packaging and distribution side, it seems libraries should normally use setup()'s install_requires argument, while applications can use requirements.txt, for example.

I think it would be good if the User Guide started articulating this distinction (e.g. in the glossary), so that it can eventually be made more clear which use cases the different advice in the Guide applies to. (For example, I think most of the advice in the tutorials is for installing and packaging libraries rather than applications, even though the language uses the more general term "project.")

This is a bit related to the following (but more general): https://github.com/pypa/python-packaging-user-guide/issues/10

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず User Guide、特に用語集と、インストールおよびパッケージングについて説明しているチュートリアルを読み、その後、issue に記載されているライブラリとアプリケーションに関するガイダンスを比較してください。違いを明確にし、関連する、より広範なプロジェクト用語に関する issue も考慮しながら、それぞれのプロジェクト種別にどのガイダンスが適用されるかを示してください。User Guide がこれらのユースケースを一貫して伝えられれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
30/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。