pypa / pypa/packaging.python.org
Definition of "project"
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 1.7k
- Fork
- 1.7k
- Merge medio
- 3g 12h
- PR unite (30g)
- 4
Descrizione
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?
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia con la voce “project” nel glossario di packaging.python.org collegato nell’issue e rivedi i suoi due paragrafi di definizione, in particolare il riferimento a una directory src di un progetto. Chiarisci il termine e rimuovi le formulazioni che presumono che ogni progetto abbia una directory src; il lavoro è completo quando la definizione è comprensibile senza che il lettore debba dedurre che cosa significhi “project”.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 32/100