diff options
| author | Éric Araujo <merwok@netwok.org> | 2011-06-19 17:23:48 (GMT) |
|---|---|---|
| committer | Éric Araujo <merwok@netwok.org> | 2011-06-19 17:23:48 (GMT) |
| commit | e043b6bac7c2d2845e0b1d10d140364c73de8456 (patch) | |
| tree | 57f5972e3239ebd80d1c4ab9fe39f41514a26f7d /Doc/library/packaging.pypi.rst | |
| parent | 348c572dcf1716f2cb2b5244b872ab9b186474da (diff) | |
| download | cpython-e043b6bac7c2d2845e0b1d10d140364c73de8456.zip cpython-e043b6bac7c2d2845e0b1d10d140364c73de8456.tar.gz cpython-e043b6bac7c2d2845e0b1d10d140364c73de8456.tar.bz2 | |
Add missing documentation for packaging.pypi.base and .simple
Diffstat (limited to 'Doc/library/packaging.pypi.rst')
| -rw-r--r-- | Doc/library/packaging.pypi.rst | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/Doc/library/packaging.pypi.rst b/Doc/library/packaging.pypi.rst index 93b61c9..14602ce 100644 --- a/Doc/library/packaging.pypi.rst +++ b/Doc/library/packaging.pypi.rst @@ -51,3 +51,24 @@ with a preference toward the latter. .. method:: get_release .. method:: get_releases + + +:mod:`packaging.pypi.base` --- Base class for index crawlers +============================================================ + +.. module:: packaging.pypi.base + :synopsis: Base class used to implement crawlers. + + +.. class:: BaseClient(prefer_final, prefer_source) + + Base class containing common methods for the index crawlers or clients. One + method is currently defined: + + .. method:: download_distribution(requirements, temp_path=None, \ + prefer_source=None, prefer_final=None) + + Download a distribution from the last release according to the + requirements. If *temp_path* is provided, download to this path, + otherwise, create a temporary directory for the download. If a release is + found, the full path to the downloaded file is returned. |