.. Yarg documentation master file

Yarg: A PyPI client
===================

.. image:: https://img.shields.io/travis/kura/yarg.svg?style=flat

.. image:: https://img.shields.io/coveralls/kura/yarg.svg?style=flat

.. image:: https://pypip.in/version/yarg/badge.svg?style=flat

.. image:: https://pypip.in/download/yarg/badge.svg?style=flat

.. image:: https://pypip.in/py_versions/yarg/badge.svg?style=flat

.. image:: https://pypip.in/implementation/yarg/badge.svg?style=flat

.. image:: https://pypip.in/status/yarg/badge.svg?style=flat

.. image:: https://pypip.in/wheel/yarg/badge.svg?style=flat

.. image:: https://pypip.in/license/yarg/badge.svg?style=flat

yarg(1) -- A semi hard Cornish cheese, also queries PyPI.
Built on top of `requests
<http://docs.python-requests.org/en/latest/>`_, it's
easy to use and makes sense.

.. code-block:: python

    >>> import yarg
    >>> package = yarg.get("yarg")
    >>> package.name
    'yarg'
    >>> package.author
    Author(name='Kura', email='kura@kura.io')

Yarg is released under the `MIT license
<https://github.com/kura/yarg/blob/master/LICENSE>`_. The `source code is on
GitHub <https://github.com/kura/yarg>`_ and `issues are also tracked on
GitHub <https://github.com/kura/yarg/issues>`_.

Yarg in action
--------------

- `Yarg is used extensively on pypip.in
  <https://github.com/badges/pypipins/blob/master/shields/shields.py>`_
- `Yarg being used on djangopackages.com
  <https://github.com/pydanny/djangopackages/issues/289>`_

Yarg documentation
------------------

.. toctree::
   :maxdepth: 2

   intro
   api-search
   api-rss
   testing

Changelog
---------

.. toctree::
    :maxdepth: 2

    changelog

Contributors
------------

.. toctree::
    :maxdepth: 2

    contributors

Help
----

.. toctree::
    :maxdepth: 2

    faq