summaryrefslogtreecommitdiffstats
path: root/doc/languages-frameworks
diff options
context:
space:
mode:
authorFrederik Rietdijk <fridh@fridh.nl>2022-09-22 13:28:11 +0200
committerFrederik Rietdijk <fridh@fridh.nl>2022-09-22 13:31:58 +0200
commit9e02095f4ebf30eaf3291bca1e495e475e0a0784 (patch)
treed57af1f5b1900a4dd23d7ae15a967eff9a0e66d9 /doc/languages-frameworks
parentc2ab0162a0913713de35a15dbad4dbccd6732202 (diff)
Python docs: document attribute to use for non-PyPI projects
Diffstat (limited to 'doc/languages-frameworks')
-rw-r--r--doc/languages-frameworks/python.section.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/languages-frameworks/python.section.md b/doc/languages-frameworks/python.section.md
index bde4183a65b1..fa7aa3ec924e 100644
--- a/doc/languages-frameworks/python.section.md
+++ b/doc/languages-frameworks/python.section.md
@@ -1780,6 +1780,10 @@ The following rules are desired to be respected:
that characters should be converted to lowercase and `.` and `_` should be
replaced by a single `-` (foo-bar-baz instead of Foo__Bar.baz).
If necessary, `pname` has to be given a different value within `fetchPypi`.
+* Packages from sources such as GitHub and GitLab that do not exist on PyPI
+ should not use a name that is already used on PyPI. When possible, they should
+ use the package repository name prefixed with the owner (e.g. organization) name
+ and using a `-` as delimiter.
* Attribute names in `python-packages.nix` should be sorted alphanumerically to
avoid merge conflicts and ease locating attributes.