Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Require python3- prefix with PyPI keys #25508

Merged
merged 5 commits into from
Aug 13, 2020
Merged

Require python3- prefix with PyPI keys #25508

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e05f3e6
Don't recommend python*- prefix with PyPI keeys
sloretz Jun 17, 2020
faad0f2
Move sentence to it's not confused with example.
sloretz Jun 17, 2020
c3935b7
Require python3- prefix
sloretz Aug 5, 2020
a8e3d03
Update CONTRIBUTING.md
sloretz Aug 5, 2020
c6ed501
When -> when
sloretz Aug 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Require python3- prefix 
Signed-off-by: Shane Loretz <[email protected]>
  • Loading branch information
@sloretz
sloretz committed Aug 5, 2020
commit c3935b73d6c77a6c8dcf20d792ccfb76415300ed
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,18 +148,20 @@ Additionally, if you rely on a dependency that uses `_python3`-suffixed codename

#### pip

Python packages, which are only available on [PyPI](https://pypi.org/) should use the `-pip` extension to avoid colliding with future keys from package managers.
Python packages, which are only available on [PyPI](https://pypi.org/), should use the prefix `python3-` and suffix `-pip` to avoid colliding with future keys from package managers.

For example:

```yaml
foobar-pip:
python3-foobar-pip:
ubuntu:
pip:
packages: [foobar]
```

Some existing rules are duplicated with `python-` or `python3-` prefixes, but this is no longer recommended.
Some existing rules do not have `python-` or `python3-` prefixes, but this is no longer recommended.
If the package ever becomes available in Debian or Ubuntu, the `python3-` prefix makes sure the `pip` key is next to it alphabetically.
sloretz marked this conversation as resolved.
Show resolved Hide resolved
The `-pip` key should be removed When the package becomes available on all platforms, and all existing users of the `-pip` key should migrate to the new key.
sloretz marked this conversation as resolved.
Show resolved Hide resolved

How to submit pull requests
---------------------------
Expand Down