[New-bugs-announce] [issue5366] examples for dependency keywords in setup.py

[anatoly techtonik]

New submission from anatoly techtonik <techtonik at gmail.com>:

When documentation grows too large it is nice to have clear examples
that stand out of text. Explanation is important to get the idea, but 
for a reference cookbook examples work better.

Here is a patch to clarify the usage of *requires* and *provides*
keywords in setup.py on the documentation page
http://docs.python.org/distutils/setupscript.html#relationships-between-distributions-and-packages


--- setupscript_old.txt	Wed Feb 25 17:09:41 2009
+++ setupscript.txt	Wed Feb 25 17:34:00 2009
@@ -423,6 +423,14 @@
 distribution being described.  If no qualifiers are given, all versions
of the
 named module or package are understood to be obsoleted.
 
+Example of using *requires* and *provides* keywords ::
+
+   setup(...,
+         requires=['dbm', 'foo=>1.1.0'],
+         provides=['myapi (1.1)'],
+        )
+
+
 
 Installing Scripts
 ==================

----------
assignee: tarek
components: Distutils, Documentation
files: setupscript.diff
keywords: patch
messages: 82706
nosy: tarek, techtonik
severity: normal
status: open
title: examples for dependency keywords in setup.py
Added file: http://bugs.python.org/file13173/setupscript.diff

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue5366>
_______________________________________