yolk


Nameyolk JSON
Version 0.4.3 PyPI version JSON
download
home_pagehttps://github.com/cakebread/yolk
SummaryCommand-line tool for querying PyPI and Python packages installed on your system.
upload_time2012-02-06 21:36:11
maintainerNone
docs_urlNone
authorRob Cakebread
requires_pythonNone
licenseBSD License
keywords pypi setuptools cheeseshop distutils eggs package management
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            yolk 0.4.3
==========

.. contents::

Installation
------------

You can install yolk with ``pip install yolk`` or via your distro's package manager, if available.

As of 0.0.7 yolk is in Gentoo's Portage tree as dev-python/yolk and a plugin for Portage named dev-python/yolk-portage. The portage plugin shows you which Python packages were installed via Portage and which were installed directly with pip (or easy_install). Check out that plugin and make one for your favorite distro. It's a great way to find Python cruft.


Summary
-------

Yolk is a Python tool for obtaining information about installed Python packages and querying packages avilable on PyPI (Python Package Index). 

You can see which packages are active, non-active or in development mode and show you which have newer versions available by querying PyPI. 

Usage Examples::

    $ yolk -l
         List all installed Python packages

    $ yolk -a 
         List only the activated packages installed (Activated packages are normal packages on sys.path you can import) 

    $ yolk -n 
         List only the non-activated (--multi-version) packages installed 
         
    $ yolk -l -f License,Author nose==1.0
         Show the license and author for version 1.0 of the package `nose`

    $ yolk --entry-map nose
         Show entry map for the nose package

    $ yolk --entry-points nose.plugins
         Show all setuptools entry points for nose.plugins


These options query PyPI::

    $ yolk -U pkg_name
         Shows if an update for pkg_name is available by querying PyPI

    $ yolk -U
         Checks PyPI to see if any installed Python packages have updates available.

    $ yolk -F Paste
         Download source tarball for latest version of Paste to your current directory

    $ yolk -F Paste -T svn
         Do a subversion checkout for Paste to a directory named Paste_svn in your current directory.

    $ yolk -L 2
         Show list of CheeseShop releases in the last two hours

    $ yolk -C 2
         Show detailed list of changes in the CheeseShop in the last two hours

    $ yolk -M Paste==1.0 
         Show all the metadata for Paste version 1.0 

    $ yolk -M Paste 
         Show all the metadata for the latest version of Paste listed on PyPi

    $ yolk -D cheesecake 
         Show all (source, egg, svn) URL's for the latest version of cheesecake packages

     $ yolk -T source -D cheesecake 
         Show only source code releases for cheesecake 

     $ yolk -H twisted 
         Launches your web browser at Twisted's home page 


Tips and Tricks
---------------

 * Use yolk inside your virtualenv to see which packages are installed.

 * Upgrade all installed Python packages:


 Warning: You only want to do this inside a virtualenv. If you're using Linux, use your package manager to install Python packages globally whenever possible. Think twice before upgrading all packages system-wide on OSX.

     $ pip install -U `yolk -U | awk '{print $1}'`



Changes
-------
**0.4.3**: Added missing documentation and license files


           
**0.4.2**: Fix for -C when an integer isn't supplied
           
           Fix for --entry-map from Jesus Rivero (Neurogeek) neurogeek@gentoo.org. Thanks, Jesus!
		
		   Switch to BSD license from GPL-2


**0.4.1**: Fix for -f fields
           
           Add check for integer with -L


**0.4.0**: Added http proxy support for XML-RPC
            
           Added case-insensitive search for -f

           Non-existent packages with -S no longer show entire index (bug was with PyPI)

           Fixed exception when package has no metadata


**0.3.0**: Added -C and -L options for new PyPI XML-RPC methods `changelog` and `updated_releases`

           Always check package name cache on disk before querying PyPi to see if a package exists and has proper case.

           Added -F option to download source, egg or subversion checkouts.

           Removed -L RSS feed option because the new `updated_releases` XML-RPC method is much nicer

           Fixed '-D -T egg' so it won't return source if no egg is available

           Major refactoring.

           Removed dependency on elementtree 

           
**0.2.0**: Added 'svn' type for -T

           A kablillion bug fixes


**0.1.0**: You can now use -f with -M

           More accurate URL's with -D using pip

           Ability to check for a single package with -U

           Uses std Python logging module

           Fixed bug so we have correct exit codes


**0.0.7**: New options: --entry-map and -entry-points
           
           Improved results with --download-links

           New plugin system. First plugin available: yolk-portage
           for Gentoo Linux.

           -v option is now --version

           -v is now a new option: --verbose

           Many bug fixes.


**0.0.6**: Fix Windows problem which showed all pkgs in develop mode
           on some systems.

           Fix bad interpreter shebang in rss_feed.py example

           Start using nose unit tests from setup.py

           Use restructuredtext in docstrings


**0.0.5**: Show packages installed in 'development' mode.

           Improved output of -l, -n and -a. You can get the previous (<=0.0.4)
           output by adding '-f Summary'

           More sanity checking for various options.

           Don't throw exception if there is no package metadata


**0.0.4**: Added -U option to query PyPI for new versions of packages you have 
           installed

Requirements
------------

* setuptools (Distribute preferred)

* elementtree (For RSS feed option extra_requires [RSS]) (included in Python >=2.5)
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/cakebread/yolk",
    "name": "yolk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "PyPI setuptools cheeseshop distutils eggs package management",
    "author": "Rob Cakebread",
    "author_email": "cakebread @ gmail",
    "download_url": "https://files.pythonhosted.org/packages/2b/c0/73510e50668b70f3fad25328c58d7a29a300a2e452058dfdcb7c7538af7b/yolk-0.4.3.tar.gz",
    "platform": "UNKNOWN",
    "description": "yolk 0.4.3\n==========\n\n.. contents::\n\nInstallation\n------------\n\nYou can install yolk with ``pip install yolk`` or via your distro's package manager, if available.\n\nAs of 0.0.7 yolk is in Gentoo's Portage tree as dev-python/yolk and a plugin for Portage named dev-python/yolk-portage. The portage plugin shows you which Python packages were installed via Portage and which were installed directly with pip (or easy_install). Check out that plugin and make one for your favorite distro. It's a great way to find Python cruft.\n\n\nSummary\n-------\n\nYolk is a Python tool for obtaining information about installed Python packages and querying packages avilable on PyPI (Python Package Index). \n\nYou can see which packages are active, non-active or in development mode and show you which have newer versions available by querying PyPI. \n\nUsage Examples::\n\n    $ yolk -l\n         List all installed Python packages\n\n    $ yolk -a \n         List only the activated packages installed (Activated packages are normal packages on sys.path you can import) \n\n    $ yolk -n \n         List only the non-activated (--multi-version) packages installed \n         \n    $ yolk -l -f License,Author nose==1.0\n         Show the license and author for version 1.0 of the package `nose`\n\n    $ yolk --entry-map nose\n         Show entry map for the nose package\n\n    $ yolk --entry-points nose.plugins\n         Show all setuptools entry points for nose.plugins\n\n\nThese options query PyPI::\n\n    $ yolk -U pkg_name\n         Shows if an update for pkg_name is available by querying PyPI\n\n    $ yolk -U\n         Checks PyPI to see if any installed Python packages have updates available.\n\n    $ yolk -F Paste\n         Download source tarball for latest version of Paste to your current directory\n\n    $ yolk -F Paste -T svn\n         Do a subversion checkout for Paste to a directory named Paste_svn in your current directory.\n\n    $ yolk -L 2\n         Show list of CheeseShop releases in the last two hours\n\n    $ yolk -C 2\n         Show detailed list of changes in the CheeseShop in the last two hours\n\n    $ yolk -M Paste==1.0 \n         Show all the metadata for Paste version 1.0 \n\n    $ yolk -M Paste \n         Show all the metadata for the latest version of Paste listed on PyPi\n\n    $ yolk -D cheesecake \n         Show all (source, egg, svn) URL's for the latest version of cheesecake packages\n\n     $ yolk -T source -D cheesecake \n         Show only source code releases for cheesecake \n\n     $ yolk -H twisted \n         Launches your web browser at Twisted's home page \n\n\nTips and Tricks\n---------------\n\n * Use yolk inside your virtualenv to see which packages are installed.\n\n * Upgrade all installed Python packages:\n\n\n Warning: You only want to do this inside a virtualenv. If you're using Linux, use your package manager to install Python packages globally whenever possible. Think twice before upgrading all packages system-wide on OSX.\n\n     $ pip install -U `yolk -U | awk '{print $1}'`\n\n\n\nChanges\n-------\n**0.4.3**: Added missing documentation and license files\n\n\n           \n**0.4.2**: Fix for -C when an integer isn't supplied\n           \n           Fix for --entry-map from Jesus Rivero (Neurogeek) neurogeek@gentoo.org. Thanks, Jesus!\n\t\t\n\t\t   Switch to BSD license from GPL-2\n\n\n**0.4.1**: Fix for -f fields\n           \n           Add check for integer with -L\n\n\n**0.4.0**: Added http proxy support for XML-RPC\n            \n           Added case-insensitive search for -f\n\n           Non-existent packages with -S no longer show entire index (bug was with PyPI)\n\n           Fixed exception when package has no metadata\n\n\n**0.3.0**: Added -C and -L options for new PyPI XML-RPC methods `changelog` and `updated_releases`\n\n           Always check package name cache on disk before querying PyPi to see if a package exists and has proper case.\n\n           Added -F option to download source, egg or subversion checkouts.\n\n           Removed -L RSS feed option because the new `updated_releases` XML-RPC method is much nicer\n\n           Fixed '-D -T egg' so it won't return source if no egg is available\n\n           Major refactoring.\n\n           Removed dependency on elementtree \n\n           \n**0.2.0**: Added 'svn' type for -T\n\n           A kablillion bug fixes\n\n\n**0.1.0**: You can now use -f with -M\n\n           More accurate URL's with -D using pip\n\n           Ability to check for a single package with -U\n\n           Uses std Python logging module\n\n           Fixed bug so we have correct exit codes\n\n\n**0.0.7**: New options: --entry-map and -entry-points\n           \n           Improved results with --download-links\n\n           New plugin system. First plugin available: yolk-portage\n           for Gentoo Linux.\n\n           -v option is now --version\n\n           -v is now a new option: --verbose\n\n           Many bug fixes.\n\n\n**0.0.6**: Fix Windows problem which showed all pkgs in develop mode\n           on some systems.\n\n           Fix bad interpreter shebang in rss_feed.py example\n\n           Start using nose unit tests from setup.py\n\n           Use restructuredtext in docstrings\n\n\n**0.0.5**: Show packages installed in 'development' mode.\n\n           Improved output of -l, -n and -a. You can get the previous (<=0.0.4)\n           output by adding '-f Summary'\n\n           More sanity checking for various options.\n\n           Don't throw exception if there is no package metadata\n\n\n**0.0.4**: Added -U option to query PyPI for new versions of packages you have \n           installed\n\nRequirements\n------------\n\n* setuptools (Distribute preferred)\n\n* elementtree (For RSS feed option extra_requires [RSS]) (included in Python >=2.5)",
    "bugtrack_url": null,
    "license": "BSD License",
    "summary": "Command-line tool for querying PyPI and Python packages installed on your system.",
    "version": "0.4.3",
    "project_urls": {
        "Download": "UNKNOWN",
        "Homepage": "https://github.com/cakebread/yolk"
    },
    "split_keywords": [
        "pypi",
        "setuptools",
        "cheeseshop",
        "distutils",
        "eggs",
        "package",
        "management"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2bc073510e50668b70f3fad25328c58d7a29a300a2e452058dfdcb7c7538af7b",
                "md5": "10dfabca7a020058436aec9dbad70123",
                "sha256": "1c07eb4001dc133c08e66e38c5d58faa7616ae804f8d0ab02dd44a1044e7ddb8"
            },
            "downloads": -1,
            "filename": "yolk-0.4.3.tar.gz",
            "has_sig": false,
            "md5_digest": "10dfabca7a020058436aec9dbad70123",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 86100,
            "upload_time": "2012-02-06T21:36:11",
            "upload_time_iso_8601": "2012-02-06T21:36:11.709366Z",
            "url": "https://files.pythonhosted.org/packages/2b/c0/73510e50668b70f3fad25328c58d7a29a300a2e452058dfdcb7c7538af7b/yolk-0.4.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2012-02-06 21:36:11",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "cakebread",
    "github_project": "yolk",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "tox": true,
    "lcname": "yolk"
}
        
Elapsed time: 0.09314s