From fa1318a4b29050341b5397685bc26ecf6ed57d52 Mon Sep 17 00:00:00 2001 From: Paulo Koch Date: Thu, 13 Sep 2012 00:20:05 +0100 Subject: Add docs for using VCS repos as dependency_links. --HG-- branch : distribute extra : rebase_source : 5795a4e630010c2380cb777c94f9bbc73fafd401 --- docs/setuptools.txt | 35 +++++++++++++++++++++++++++++++---- 1 file changed, 31 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/setuptools.txt b/docs/setuptools.txt index 31eedcb1..e0557984 100644 --- a/docs/setuptools.txt +++ b/docs/setuptools.txt @@ -616,14 +616,20 @@ Dependencies that aren't in PyPI If your project depends on packages that aren't registered in PyPI, you may still be able to depend on them, as long as they are available for download -as an egg, in the standard distutils ``sdist`` format, or as a single ``.py`` -file. You just need to add some URLs to the ``dependency_links`` argument to +as: + +- an egg, in the standard distutils ``sdist`` format, +- a single ``.py`` file, or +- a VCS repository (Subversion, Mercurial, or Git). + +You just need to add some URLs to the ``dependency_links`` argument to ``setup()``. The URLs must be either: -1. direct download URLs, or -2. the URLs of web pages that contain direct download links +1. direct download URLs, +2. the URLs of web pages that contain direct download links, or +3. the repository's URL In general, it's better to link to web pages, because it is usually less complex to update a web page than to release a new version of your project. @@ -637,6 +643,27 @@ by replacing them with underscores.) EasyInstall will recognize this suffix and automatically create a trivial ``setup.py`` to wrap the single ``.py`` file as an egg. +In the case of a VCS checkout, you should also append ``#egg=project-version`` +in order to identify for what package that checkout should be used. You can +append ``@REV`` to the URL's path (before the fragment) to specify a revision. +Additionally, you can also force the VCS being used by prepending the URL with +a certain prefix. Currently available are: + +- ``svn+URL`` for Subversion, +- ``git+URL`` for Git, and +- ``hg+URL`` for Mercurial + +A more complete example would be: + + ``vcs+proto://host/path@revision#egg=project-version`` + +Be careful with the version. It should match the one inside the project files. +If you want do disregard the version, you have to omit it both in the +``requires`` and in the URL's fragment. + +This will do a checkout (or a clone, in Git and Mercurial parlance) to a +temporary folder and run ``setup.py bdist_egg``. + The ``dependency_links`` option takes the form of a list of URL strings. For example, the below will cause EasyInstall to search the specified page for eggs or source distributions, if the package's dependencies aren't already -- cgit v1.2.1 From 0a1a4cdedb6bfd3e1fc2121275dd765c597e33ed Mon Sep 17 00:00:00 2001 From: "Stefan H. Holek" Date: Fri, 19 Oct 2012 04:15:58 +0200 Subject: Update CHANGES and docs. --HG-- branch : distribute extra : rebase_source : e24a57706eebda4c1f989467a0a3bc951f550dd4 --- docs/setuptools.txt | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/setuptools.txt b/docs/setuptools.txt index 31eedcb1..81c3aae3 100644 --- a/docs/setuptools.txt +++ b/docs/setuptools.txt @@ -2423,7 +2423,12 @@ command:: python setup.py upload_docs --upload-dir=docs/build/html -As with any other ``setuptools`` based command, you can define useful +If no ``--upload-dir`` is given, ``upload_docs`` will attempt to run the +``build_sphinx`` command to generate uploadable documentation. +For the command to become available, `Sphinx `_ +must be installed in the same environment as distribute. + +As with other ``setuptools``-based commands, you can define useful defaults in the ``setup.cfg`` of your Python project, e.g.: .. code-block:: ini -- cgit v1.2.1 From ae5c5639d3704b1c4caece39839b6135fe8381b7 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 21 Oct 2012 04:01:36 -0400 Subject: Bumped to 0.6.30 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 2181b40073d9790f489b692900f53c5efb3c34cd --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index 7b82a884..e6cfdca0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.29' +version = '0.6.30' # The full version, including alpha/beta/rc tags. -release = '0.6.29' +release = '0.6.30' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 69fa64f972dc95b9e9bb583229e20bb117fb7102 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Mon, 22 Oct 2012 06:03:05 -0400 Subject: Bumped to 0.6.31 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 74ac06a235b4d51a69d5be1c494bf922c8093072 --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index e6cfdca0..08fa643d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.30' +version = '0.6.31' # The full version, including alpha/beta/rc tags. -release = '0.6.30' +release = '0.6.31' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 40102f07a08808c2c356891608fd201ee02e618b Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 24 Nov 2012 23:04:02 -0500 Subject: Bumped to 0.6.32 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 107cb8e68f5d9d947096d0733e841ba568df0be2 --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index 08fa643d..c1417e77 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.31' +version = '0.6.32' # The full version, including alpha/beta/rc tags. -release = '0.6.31' +release = '0.6.32' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 1c2dff7451101c9cfb37e4ae16eb23ef17332f5a Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Mon, 26 Nov 2012 12:18:36 -0500 Subject: Bumped to 0.6.33 in preparation for next release. --HG-- branch : distribute extra : rebase_source : cbb90a165b1e410ac7998fe5a57f0c84e9c024d3 --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index c1417e77..af26376e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.32' +version = '0.6.33' # The full version, including alpha/beta/rc tags. -release = '0.6.32' +release = '0.6.33' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 2a3d28cf5fed225bfe2c3f95dfbf61c2d23fd6c4 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 29 Dec 2012 17:10:54 -0500 Subject: Bumped to 0.6.34 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 4455898775fbb40a5a331909c61d45622a9ea97a --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index af26376e..15226651 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.33' +version = '0.6.34' # The full version, including alpha/beta/rc tags. -release = '0.6.33' +release = '0.6.34' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 9e26a920ffd60595ed80f1c4e6f4bdd49507c0f2 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Mon, 31 Dec 2012 10:27:51 -0500 Subject: Bumped to 0.6.35 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 77f34fdeebd01224a2d399855f0674108133b3e6 --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index 15226651..98380ba9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.34' +version = '0.6.35' # The full version, including alpha/beta/rc tags. -release = '0.6.34' +release = '0.6.35' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 3a467f695d9a10fec13bf7b0206ecc10af6517f2 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 16 Feb 2013 02:47:06 -0500 Subject: Updated docs to match originally-intended behavior and the behavior of setuptools 0.6. This fixes #278. --HG-- branch : distribute extra : rebase_source : 2b4f2ca890d32a2d1a3179bb1805b6a1f1e9be77 --- docs/setuptools.txt | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) (limited to 'docs') diff --git a/docs/setuptools.txt b/docs/setuptools.txt index 31ecc931..fe8bb3f6 100644 --- a/docs/setuptools.txt +++ b/docs/setuptools.txt @@ -187,10 +187,11 @@ than ``2.4.1`` (which has a higher release number). A pre-release tag is a series of letters that are alphabetically before "final". Some examples of prerelease tags would include ``alpha``, ``beta``, -``a``, ``c``, ``dev``, and so on. You do not have to place a dot before -the prerelease tag if it's immediately after a number, but it's okay to do -so if you prefer. Thus, ``2.4c1`` and ``2.4.c1`` both represent release -candidate 1 of version ``2.4``, and are treated as identical by setuptools. +``a``, ``c``, ``dev``, and so on. You do not have to place a dot or dash +before the prerelease tag if it's immediately after a number, but it's okay to +do so if you prefer. Thus, ``2.4c1`` and ``2.4.c1`` and ``2.4-c1`` all +represent release candidate 1 of version ``2.4``, and are treated as identical +by setuptools. In addition, there are three special prerelease tags that are treated as if they were the letter ``c``: ``pre``, ``preview``, and ``rc``. So, version @@ -216,13 +217,6 @@ a post-release tag, so this version is *newer* than ``0.6a9.dev``. For the most part, setuptools' interpretation of version numbers is intuitive, but here are a few tips that will keep you out of trouble in the corner cases: -* Don't use ``-`` or any other character than ``.`` as a separator, unless you - really want a post-release. Remember that ``2.1-rc2`` means you've - *already* released ``2.1``, whereas ``2.1rc2`` and ``2.1.c2`` are candidates - you're putting out *before* ``2.1``. If you accidentally distribute copies - of a post-release that you meant to be a pre-release, the only safe fix is to - bump your main release number (e.g. to ``2.1.1``) and re-release the project. - * Don't stick adjoining pre-release tags together without a dot or number between them. Version ``1.9adev`` is the ``adev`` prerelease of ``1.9``, *not* a development pre-release of ``1.9a``. Use ``.dev`` instead, as in @@ -239,7 +233,7 @@ but here are a few tips that will keep you out of trouble in the corner cases: >>> parse_version('1.9.a.dev') == parse_version('1.9a0dev') True >>> parse_version('2.1-rc2') < parse_version('2.1') - False + True >>> parse_version('0.6a9dev-r41475') < parse_version('0.6a9') True -- cgit v1.2.1 From 1e7b49282e6f36d5d624bdf50f1ea9a34f52cfee Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 16 Feb 2013 03:12:35 -0500 Subject: Bumped to 0.6.36 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 82ea3f25bc7836db7398b0e602ef34baa1f2c34e --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index 98380ba9..586e3fe6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.35' +version = '0.6.36' # The full version, including alpha/beta/rc tags. -release = '0.6.35' +release = '0.6.36' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From db6d5f7ac474fa0605213514e793f98a0157a2ab Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 5 Apr 2013 17:14:51 -0400 Subject: Bumped to 0.6.37 in preparation for next release. --HG-- branch : distribute extra : rebase_source : a59fcbbf5ca73fb41958d42d33d3de299ad9ae7c --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index 586e3fe6..0a943a16 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.36' +version = '0.6.37' # The full version, including alpha/beta/rc tags. -release = '0.6.36' +release = '0.6.37' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From a34e56cef2e2cb2aea3d4ff5b532949d426e3b97 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 4 May 2013 22:10:00 -0400 Subject: Bumped to 0.6.38 in preparation for next release. --HG-- branch : distribute extra : rebase_source : cf2ffa52b8e0cf1403b4e8ca23921a4cda51ba5b --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index 0a943a16..b5dc23bd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.37' +version = '0.6.38' # The full version, including alpha/beta/rc tags. -release = '0.6.37' +release = '0.6.38' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 878a81c62061ab506ed1874d541cbeb714fe06fe Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 5 May 2013 08:45:43 -0400 Subject: Bumped to 0.6.39 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 3e627b0d100b8ae32e8dc995f2da0003bbd9c605 --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index b5dc23bd..fc60a008 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.38' +version = '0.6.39' # The full version, including alpha/beta/rc tags. -release = '0.6.38' +release = '0.6.39' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 3ab400cd437e4839cb8d4cc70dd5889a5b0c7469 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 12 May 2013 14:13:13 -0400 Subject: Bumped to 0.6.40 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 355bf27e11fdf906de100c2a47145d44fac082cc --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index fc60a008..ac332deb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.39' +version = '0.6.40' # The full version, including alpha/beta/rc tags. -release = '0.6.39' +release = '0.6.40' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 41a57f84efc8284964450615dca400bc17bbbb4e Mon Sep 17 00:00:00 2001 From: Guy Rozendorn Date: Tue, 14 May 2013 11:15:38 +0300 Subject: Bumped to 0.6.41 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 235fe544e2119364d2f4270a6c5ca20db4645324 --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index ac332deb..b645cce7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.40' +version = '0.6.41' # The full version, including alpha/beta/rc tags. -release = '0.6.40' +release = '0.6.41' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From cf2a28328628a15a95ec354f8c3a4421d3652e31 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 24 May 2013 09:59:08 -0400 Subject: Bumped to 0.6.42 in preparation for next release. --HG-- branch : distribute --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index b645cce7..bd9028b6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.41' +version = '0.6.42' # The full version, including alpha/beta/rc tags. -release = '0.6.41' +release = '0.6.42' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 3116049570db091f6824a36e93925be75e9a7ab5 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 24 May 2013 16:04:19 -0400 Subject: Bumped to 0.6.43 in preparation for next release. --HG-- branch : distribute --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index bd9028b6..e4e982b0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.42' +version = '0.6.43' # The full version, including alpha/beta/rc tags. -release = '0.6.42' +release = '0.6.43' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From c12b3db412210faa982134dce22b5e6ddad31bba Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 24 May 2013 20:43:50 -0400 Subject: Bumped to 0.6.44 in preparation for next release. --HG-- branch : distribute --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index e4e982b0..02d11707 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.43' +version = '0.6.44' # The full version, including alpha/beta/rc tags. -release = '0.6.43' +release = '0.6.44' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 4edd0409cb3a47e3ad8bd681cddfe9957d1e7da9 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Tue, 28 May 2013 11:20:05 -0400 Subject: Bumped to 0.6.45 in preparation for next release. --HG-- branch : distribute --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index 02d11707..ff934d40 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.44' +version = '0.6.45' # The full version, including alpha/beta/rc tags. -release = '0.6.44' +release = '0.6.45' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 641eac6550896506fa939205f249bcfb8f057d57 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Wed, 29 May 2013 07:37:04 -0400 Subject: Bumped to 0.6.46 in preparation for next release. --HG-- branch : distribute --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index ff934d40..ba020915 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.45' +version = '0.6.46' # The full version, including alpha/beta/rc tags. -release = '0.6.45' +release = '0.6.46' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1