Add explanatory comment about generated setup.py scripts

pypa · Apr 7, 2020 · 8ed3317 · 8ed3317
1 parent 28d74f5
commit 8ed3317
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/flit/sdist.py b/flit/sdist.py
@@ -13,6 +13,10 @@
 
 log = logging.getLogger(__name__)
 
+# Our generated setup.py deliberately loads distutils, not setuptools, to
+# discourage running it directly and getting a setuptools mess. Tools like pip
+# handle this correctly - loading setuptools anyway but avoiding its issues.
+
 SETUP = """\
 #!/usr/bin/env python
 # setup.py generated by flit for tools that don't yet use PEP 517