Package yolk :: Module cli
[show private | hide private]
[frames | no frames]

Module yolk.cli

Name: cli.py

Desc: Command-line tool for listing Python packages installed by setuptools,
      package metadata, package dependencies, and querying The Cheese Shop
      (PyPI) for Python package release information such as which installed
      packages have updates available.

Author: Rob Cakebread <gentoodev a t gmail.com>

License  : PSF (Python Software Foundation License)

Exceptions
Usage Usage exception

Function Summary
  browse_website(package_name, browser)
Launch web browser at project's homepage
  get_all_versions_pypi(package_name, use_cached_pkglist)
Fetch list of available versions for a package from The Cheese Shop
  get_pkglist()
Return list of all pkg names
  get_rss_feed()
Show last 20 package updates from PyPI RSS feed
  main()
Main function
  parse_pkg_ver(args)
Return tuple with package_name and version from CLI args
  parse_search_spec(spec)
Parse search args and return spec dict for PyPI
  print_metadata(show, metadata, active, show_metadata, fields)
Print out formatted metadata
  print_pkg_versions(package_name, versions)
Print list of versions available for a package
  pypi_search(spec)
Search PyPI by metadata keyword
  setup_opt_parser()
Setup the optparser
  show_deps(pkg_ver)
Show dependencies for package(s)
  show_distributions(show, pkg_name, version, show_metadata, fields)
Show list of installed activated OR non-activated packages
  show_download_links(package_name, version, file_type)
Query PyPI for pkg download URI for a packge
  show_pkg_metadata_pypi(package_name, version)
Show pkg metadata queried from PyPI
  show_updates(package_name, version)
Check installed packages for available updates on PyPI

Function Details

browse_website(package_name, browser=None)

Launch web browser at project's homepage

get_all_versions_pypi(package_name, use_cached_pkglist)

Fetch list of available versions for a package from The Cheese Shop

get_pkglist()

Return list of all pkg names

get_rss_feed()

Show last 20 package updates from PyPI RSS feed

main()

Main function

parse_pkg_ver(args)

Return tuple with package_name and version from CLI args

parse_search_spec(spec)

Parse search args and return spec dict for PyPI

print_metadata(show, metadata, active, show_metadata, fields)

Print out formatted metadata

print_pkg_versions(package_name, versions)

Print list of versions available for a package

pypi_search(spec)

Search PyPI by metadata keyword

setup_opt_parser()

Setup the optparser

show_deps(pkg_ver)

Show dependencies for package(s)

show_distributions(show, pkg_name, version, show_metadata, fields)

Show list of installed activated OR non-activated packages

show_download_links(package_name, version, file_type)

Query PyPI for pkg download URI for a packge

show_pkg_metadata_pypi(package_name, version)

Show pkg metadata queried from PyPI

show_updates(package_name='', version='')

Check installed packages for available updates on PyPI

Generated by Epydoc 2.1 on Mon Feb 12 18:44:10 2007 http://epydoc.sf.net