pypa / pypa/packaging.python.org

Definition of "project"

Open
#235 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.7k
Forks
1.7k
Avg merge
3d 12h
Merged PRs (30d)
4

Description

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?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the “project” entry in the packaging.python.org glossary linked in the issue and review its two definition paragraphs, especially the reference to a project src directory. Clarify the term and remove wording that assumes every project has a src directory; done means the definition is understandable without requiring the reader to infer what “project” means.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.