pypa / pypa/packaging.python.org

Definition of "project"

Offen
#235 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Python
Sterne
1.7k
Forks
1.7k
Ø Merge
3 T. 12 Std.
Gemergte PRs (30 T.)
4

Beschreibung

I am not happy with the current definition of "project"

https://packaging.python.org/en/latest/glossary/#term-project

Project

    A library, framework, script, plugin, application, or collection of data or other resources, or some combination thereof that is intended to be packaged into a Distribution.

    Since most projects create Distributions using distutils or setuptools, another practical way to define projects currently is something that contains a setup.py at the root of the project src directory, where “setup.py” is the project specification filename used by distutils and setuptools.

    Python projects must have unique names, which are registered on PyPI. Each project will then contain one or more Releases, and each release may comprise one or more distributions.

    Note that there is a strong convention to name a project after the name of the package that is imported to run that project. However, this doesn’t have to hold true. It’s possible to install a distribution from the project ‘foo’ and have it provide a package importable only as ‘bar’.

The first sentence:

A library, framework, script, plugin, application, or collection of data or other resources, or some combination thereof that is intended to be packaged into a Distribution.

... I don't get it. Sorry. My brain can't imagine what a project is after reading it. My conclusion of this sentence: A project is something.

The second:

Since most projects create Distributions using distutils or setuptools, another practical way to define projects currently is something that contains a setup.py at the root of the project src directory, where “setup.py” is the project specification filename used by distutils and setuptools.

Where is "the root of the project src directory"? I guess there are a lot of projects which don't have a src directory.

What do you think?

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit dem Eintrag „project“ im im Issue verlinkten Glossar von packaging.python.org und prüfen Sie dessen zwei Definitionsabsätze, insbesondere den Verweis auf ein src-Verzeichnis eines Projekts. Präzisieren Sie den Begriff und entfernen Sie Formulierungen, die voraussetzen, dass jedes Projekt ein src-Verzeichnis hat; die Aufgabe ist erledigt, wenn die Definition verständlich ist, ohne dass die Lesenden erschließen müssen, was „project“ bedeutet.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
32/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.