This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: setupscript examples for dependency keywords in setup.py
Type: Stage:
Components: Distutils, Documentation Versions:
process
Status: closed Resolution:
Dependencies: Superseder:
Assigned To: tarek Nosy List: tarek, techtonik
Priority: normal Keywords: patch

Created on 2009-02-25 15:41 by techtonik, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
setupscript.diff techtonik, 2009-02-25 15:41
Messages (5)
msg82706 - (view) Author: anatoly techtonik (techtonik) Date: 2009-02-25 15:41
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
 ==================
msg82769 - (view) Author: anatoly techtonik (techtonik) Date: 2009-02-26 18:33
Another thing for setupscript is to state that long_description is
actually ReStructured text.
msg82808 - (view) Author: Tarek Ziadé (tarek) * (Python committer) Date: 2009-02-27 01:43
> Another thing for setupscript is to state that long_description is
> actually ReStructured text.

I can be free text. If it's ReStructured text it will be parsed by PyPI
but this is it;
msg82809 - (view) Author: Tarek Ziadé (tarek) * (Python committer) Date: 2009-02-27 01:46
For the requires and provides, I am afraid no one really uses theses
option, and they might get deprecated at some point. So I don't think it
worth adding an example for it
msg82813 - (view) Author: Tarek Ziadé (tarek) * (Python committer) Date: 2009-02-27 02:18
I have added more details in r70007. Thanks!

notice that setupscript mentions that long_description is rest:

"""
‘long string’
    Multiple lines of plain text in reStructuredText format (see
http://docutils.sf.net/).
"""
History
Date User Action Args
2022-04-11 14:56:46adminsetgithub: 49616
2009-02-27 02:18:17tareksetstatus: open -> closed
messages: + msg82813
2009-02-27 01:46:26tareksetmessages: + msg82809
2009-02-27 01:43:57tareksetmessages: + msg82808
2009-02-26 18:33:42techtoniksetmessages: + msg82769
title: examples for dependency keywords in setup.py -> setupscript examples for dependency keywords in setup.py
2009-02-25 15:41:52techtonikcreate