Metadata-Version: 2.4
Name: pypi-cli
Version: 0.4.1
Summary: A command-line interface to the Python Package Index (PyPI).
Home-page: https://github.com/sloria/pypi-cli
Author: Steven Loria
Author-email: sloria1@gmail.com
License: Copyright 2014 Steven Loria
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
Keywords: pypi cli command line pipstat pip statistics download count metrics analytics
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: CPython
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: requests>=2.3.0
Requires-Dist: python-dateutil>=2.2
Requires-Dist: click>=3.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

********
pypi-cli
********

.. image:: https://badge.fury.io/py/pypi-cli.png
    :target: http://badge.fury.io/py/pypi-cli
    :alt: Latest version

.. image:: https://travis-ci.org/sloria/pypi-cli.png?branch=master
    :target: https://travis-ci.org/sloria/pypi-cli
    :alt: Travis-CI

A command-line interface to the Python Package Index (PyPI). Get package info, download statistics, and more.

.. image:: https://dl.dropboxusercontent.com/u/1693233/github/pypi-cli.png
    :alt: Screenshot
    :target: http://konch.readthedocs.org

Get it now
==========
::

    $ pip install pypi-cli


Requirements
============

- Python >= 2.7 or >= 3.3

Examples
========

Get Package Info
----------------

Use the ``pypi info`` command to get summary information for a package.

.. code-block:: bash

    $ pypi info matplotlib

::

    matplotlib
    ==========
    Python plotting package

    Latest release:   1.3.1

    Last day:           2,015
    Last week:         16,744
    Last month:        59,989

    Author:   John D. Hunter, Michael Droettboom
    Author email: mdroe@stsci.edu

    PyPI URL:  http://pypi.python.org/pypi/matplotlib
    Home Page: http://matplotlib.org

    License: BSD


Get Download Statistics
-----------------------

Use the ``pypi stat`` command to get download statistics for a package.

.. code-block:: bash

    $ pypi stat numpy

::

    Fetching statistics for 'http://pypi.python.org/pypi/numpy'. . .

    Download statistics for numpy
    =============================

    Downloads by version
    1.0     06/12/02 [ 1,904     ] *
    1.3.0   09/04/06 [ 34,900    ] **
    1.4.1   10/04/24 [ 17,977    ] *
    1.5.0   10/09/15 [ 23,462    ] **
    1.5.1   10/11/18 [ 49,311    ] ***
    1.6.0   11/05/14 [ 39,431    ] **
    1.6.1   11/07/24 [ 168,287   ] ********
    1.6.2   12/05/20 [ 374,288   ] ******************
    1.7.0   13/02/12 [ 147,759   ] *******
    1.7.1   13/04/07 [ 1,006,008 ] **********************************************
    1.8.0   13/10/30 [ 513,208   ] ************************
    1.7.2   13/12/31 [ 2,974     ] *
    1.8.1   14/03/26 [ 356,674   ] *****************

    Min downloads:          1,904 (1.0)
    Max downloads:      1,006,008 (1.7.1)
    Avg downloads:        210,475
    Total downloads:    2,736,183

    Last day:           3,901
    Last week:         44,842
    Last month:       182,480

Browse to a Package's PyPI or homepage
--------------------------------------

Use ``pypi browse`` to open a package's PyPI url in your browser.

.. code-block:: bash

    $ pypi browse textblob

You can also go to a package's homepage.

.. code-block:: bash

    $ pypi browse textblob --homepage

Search For Packages
-------------------

Use ``pypi search`` to search for PyPI packages.

.. code-block:: bash

    $ pypi search 'requests oauth'

::

    Search results for "requests oauth"
    suds_requests
    oauth
    requests
    requests-oauthlib
    requests-foauth
    requests-oauth
    requests-oauth2
    wsgioauth
    pmr2.oauth
    django-oauth-plus


More
====

To get help or list available commands:

.. code-block:: bash

    $ pypi --help

You can also get help with subcommands:

.. code-block:: bash

    $ pypi stat --help


License
=======

MIT licensed. See the bundled `LICENSE <https://github.com/sloria/pypi-cli/blob/master/LICENSE>`_ file for more details.


*********
Changelog
*********

0.4.1 (2015-10-04)
==================

- Use explicit u'' prefix rather than importing unicode_literals from __future__ to avoid warnings from click on Py2.
- Tested on Python 3.5.

0.4.0 (2014-12-22)
==================

- Don't pin to python-dateutil==2.2.
- Echo search results in pager.

0.3.2 (2014-09-09)
==================

- Use HTTPS urls. Thanks Alex Gaynor.
- Fix error in search when a package's summary is ``None``. Thanks Eric Lo.

0.3.1 (2014-06-18)
==================

- Disable pager for displaying search results until click has better support for ANSI styles in the pager. Thanks Arne Neumann for reporting.
- Support newer versions of click. Thanks Juraj Bubniak for reporting.

0.3.0 (2014-06-15)
==================

- Fix bug that caused search to raise a `TypeError` on Python 3. Thanks @barrio for reporting.
- Search command shows package summaries.
- Search command shows all results in the pager.


0.2.1 (2014-06-12)
==================

- Fix bug that caused a crash in search. Thanks Christian Pedersen for reporting.


0.2.0 (2014-06-09)
==================

- Add ``--web`` option to `search` command.
- Fix bug with locating packages with an underscore character.
- Add license, maintainer, and documentation info to the ``info`` command.


0.1.0 (2014-06-08)
==================

- First release.
- Supports ``stat``, ``browse``, and ``search``, and ``info`` commands.
