DESCRIPTION.rst 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. yarg(1) -- A semi hard Cornish cheese, also queries PyPI
  2. ========================================================
  3. .. image:: https://img.shields.io/travis/kura/yarg.svg?style=flat
  4. .. image:: https://img.shields.io/coveralls/kura/yarg.svg?style=flat
  5. .. image:: https://pypip.in/version/yarg/badge.svg?style=flat
  6. .. image:: https://pypip.in/download/yarg/badge.svg?style=flat
  7. .. image:: https://pypip.in/py_versions/yarg/badge.svg?style=flat
  8. .. image:: https://pypip.in/implementation/yarg/badge.svg?style=flat
  9. .. image:: https://pypip.in/status/yarg/badge.svg?style=flat
  10. .. image:: https://pypip.in/wheel/yarg/badge.svg?style=flat
  11. .. image:: https://pypip.in/license/yarg/badge.svg?style=flat
  12. Yarg is a PyPI client.
  13. .. code-block:: python
  14. >>> import yarg
  15. >>> package = yarg.get("yarg")
  16. >>> package.name
  17. u'yarg'
  18. >>> package.author
  19. Author(name=u'Kura', email=u'kura@kura.io')
  20. Full documentation is at <https://yarg.readthedocs.org>.
  21. Yarg is released under the `MIT license
  22. <https://github.com/kura/yarg/blob/master/LICENSE>`_. The `source code is on
  23. GitHub <https://github.com/kura/yarg>`_ and `issues are also tracked on
  24. GitHub <https://github.com/kura/yarg/issues>`_.
  25. Release History
  26. ===============
  27. 0.1.8 (2014-08-10)
  28. ------------------
  29. Splatting bugs
  30. ~~~~~~~~~~~~~~
  31. - Integration issue with Python 3, requests, yarg and JSON. Attempt to decode
  32. requests response if decode attribute exists.
  33. 0.1.6 & 0.1.7 (2014-08-10)
  34. --------------------------
  35. Splatting bugs
  36. ~~~~~~~~~~~~~~
  37. - Bug in setup.py causing installs to fail for sdist (source) releases.
  38. 0.1.5 (2014-08-10)
  39. ------------------
  40. API changes
  41. ~~~~~~~~~~~
  42. - Changed sort order of `yarg.package.Package.release_ids` to sort
  43. based on the upload time of the release ID.
  44. Splatting bugs
  45. ~~~~~~~~~~~~~~
  46. - `yarg.package.Package.latest_release_id` will now return the latest
  47. release ID from the PyPI info source, rather than the final list item in
  48. `yarg.package.Package.release_ids`.
  49. Addtionally `yarg.package.Package.latest_release` will do the same as
  50. it gets the latest release information from
  51. `yarg.package.Package.latest_release_id`.
  52. 0.1.4 (2014-08-09)
  53. ------------------
  54. API changes
  55. ~~~~~~~~~~~
  56. - New method `yarg.newest_packages` for querying new packages
  57. from the PyPI RSS feed.
  58. - New method `yarg.latest_updated_packages` for querying
  59. the latest updated packages from the PyPI RSS feed.
  60. Other
  61. ~~~~~
  62. - Additional test coverage
  63. - Additional documentation coverage
  64. 0.1.2 (2014-08-08)
  65. ------------------
  66. Bug fixes
  67. ~~~~~~~~~
  68. - `yarg.get` will now raise an Exception for errors **including**
  69. 300 and above. Previously only raised for above 300.
  70. - Fix an issue on Python 3.X and PyPy3 where
  71. `yarg.exceptions.HTTPError` was using a method that was
  72. removed in Python 3.
  73. - Added dictionary key lookups for `home_page`, `bugtrack_url`
  74. and `docs_url`. Caused `KeyError` exceptions if they were not
  75. returned by PyPI.
  76. Other
  77. ~~~~~
  78. - More test coverage.
  79. 0.1.1 (2014-08-08)
  80. ------------------
  81. API changes
  82. ~~~~~~~~~~~
  83. - New `yarg.package.Package` property `has_wheel`.
  84. - New `yarg.package.Package` property `has_egg`.
  85. - New `yarg.package.Package` property `has_source`.
  86. - New `yarg.package.Package` property `python_versions`.
  87. - New `yarg.package.Package` property `python_implementations`.
  88. - Added `yarg.exceptions.HTTPError` to `yarg.__init__`
  89. for easier access.
  90. - Added `yarg.json2package` to `yarg.__init__` to expose it for
  91. use.
  92. 0.1.0 (2014-08-08)
  93. ------------------
  94. - Initial release