Merge pull request #2746 from graingert/patch-1

add python_requires example
pypa · Sep 4, 2021 · 234550d · 234550d
2 parents 41df8fe + 60e3e22
commit 234550d
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/changelog.d/2746.doc.rst b/changelog.d/2746.doc.rst
@@ -0,0 +1 @@
+add python_requires example
diff --git a/docs/userguide/dependency_management.rst b/docs/userguide/dependency_management.rst
@@ -341,4 +341,25 @@ In some cases, you might need to specify the minimum required python version.
 This is handled with the ``python_requires`` keyword supplied to ``setup.cfg``
 or ``setup.py``.
 
-Example WIP
+
+.. tab:: setup.cfg
+
+    .. code-block:: ini
+
+        [metadata]
+        name = Project-B
+        #...
+
+        [options]
+        #...
+        python_requires = >=3.6
+
+.. tab:: setup.py
+
+    .. code-block:: python
+
+        setup(
+            name="Project-B",
+            python_requires=[">=3.6"],
+            ...,
+        )