Debian Codegraph @

docs/source/index.rst

raw
1 .. Yarg documentation master file
2
3 Yarg: A PyPI client
4 ===================
5
6 .. image:: https://img.shields.io/travis/kura/yarg.svg?style=flat
7
8 .. image:: https://img.shields.io/coveralls/kura/yarg.svg?style=flat
9
10 .. image:: https://pypip.in/version/yarg/badge.svg?style=flat
11
12 .. image:: https://pypip.in/download/yarg/badge.svg?style=flat
13
14 .. image:: https://pypip.in/py_versions/yarg/badge.svg?style=flat
15
16 .. image:: https://pypip.in/implementation/yarg/badge.svg?style=flat
17
18 .. image:: https://pypip.in/status/yarg/badge.svg?style=flat
19
20 .. image:: https://pypip.in/wheel/yarg/badge.svg?style=flat
21
22 .. image:: https://pypip.in/license/yarg/badge.svg?style=flat
23
24 yarg(1) -- A semi hard Cornish cheese, also queries PyPI.
25 Built on top of `requests
26 <http://docs.python-requests.org/en/latest/>`_, it's
27 easy to use and makes sense.
28
29 .. code-block:: python
30
31 >>> import yarg
32 >>> package = yarg.get("yarg")
33 >>> package.name
34 'yarg'
35 >>> package.author
36 Author(name='Kura', email='[email protected]')
37
38 Yarg is released under the `MIT license
39 <https://github.com/kura/yarg/blob/master/LICENSE>`_. The `source code is on
40 GitHub <https://github.com/kura/yarg>`_ and `issues are also tracked on
41 GitHub <https://github.com/kura/yarg/issues>`_.
42
43 Yarg in action
44 --------------
45
46 - `Yarg is used extensively on pypip.in
47 <https://github.com/badges/pypipins/blob/master/shields/shields.py>`_
48 - `Yarg being used on djangopackages.com
49 <https://github.com/pydanny/djangopackages/issues/289>`_
50
51 Yarg documentation
52 ------------------
53
54 .. toctree::
55 :maxdepth: 2
56
57 intro
58 api-search
59 api-rss
60 testing
61
62 Changelog
63 ---------
64
65 .. toctree::
66 :maxdepth: 2
67
68 changelog
69
70 Contributors
71 ------------
72
73 .. toctree::
74 :maxdepth: 2
75
76 contributors
77
78 Help
79 ----
80
81 .. toctree::
82 :maxdepth: 2
83
84 faq