index.rst 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. =====
  2. kazoo
  3. =====
  4. Kazoo is a Python library designed to make working with :term:`Zookeeper` a
  5. more hassle-free experience that is less prone to errors.
  6. Kazoo features:
  7. * A wide range of recipe implementations, like Lock, Election or Queue
  8. * Data and Children Watchers
  9. * Simplified Zookeeper connection state tracking
  10. * Unified asynchronous API for use with greenlets or threads
  11. * Support for gevent 0.13 and gevent 1.0
  12. * Support for Zookeeper 3.3 and 3.4 servers
  13. * Integrated testing helpers for Zookeeper clusters
  14. * Pure-Python based implementation of the wire protocol, avoiding all the
  15. memory leaks, lacking features, and debugging madness of the C library
  16. Kazoo is heavily inspired by `Netflix Curator`_ simplifications and helpers.
  17. .. note::
  18. You should be familiar with Zookeeper and have read the `Zookeeper
  19. Programmers Guide`_ before using `kazoo`.
  20. Reference Docs
  21. ==============
  22. .. toctree::
  23. :maxdepth: 1
  24. install
  25. basic_usage
  26. async_usage
  27. implementation
  28. testing
  29. api
  30. Changelog <changelog>
  31. Contributing <contributing>
  32. Why
  33. ===
  34. Using :term:`Zookeeper` in a safe manner can be difficult due to the variety of
  35. edge-cases in :term:`Zookeeper` and other bugs that have been present in the
  36. Python C binding. Due to how the C library utilizes a separate C thread for
  37. :term:`Zookeeper` communication some libraries like `gevent`_ also don't work
  38. properly by default.
  39. By utilizing a pure Python implementation, Kazoo handles all of these
  40. cases and provides a new asynchronous API which is consistent when
  41. using threads or `gevent`_ greenlets.
  42. Source Code
  43. ===========
  44. All source code is available on `github under kazoo <https://github.com/python-
  45. zk/kazoo>`_.
  46. Bugs/Support
  47. ============
  48. Bugs and support issues should be reported on the `kazoo github issue tracker
  49. <https://github.com/python-zk/kazoo/issues>`_.
  50. The developers of ``kazoo`` can frequently be found on the Freenode IRC
  51. network in the #zookeeper channel.
  52. For general discussions, please use the
  53. `python-zk <https://groups.google.com/forum/#!forum/python-zk>`_ mailing list
  54. hosted on Google Groups.
  55. Indices and tables
  56. ==================
  57. * :ref:`genindex`
  58. * :ref:`modindex`
  59. * :ref:`glossary`
  60. .. toctree::
  61. :hidden:
  62. glossary
  63. License
  64. =======
  65. ``kazoo`` is offered under the Apache License 2.0.
  66. Authors
  67. =======
  68. ``kazoo`` started under the `Nimbus Project`_ and through collaboration with
  69. the open-source community has been merged with code from `Mozilla`_ and the
  70. `Zope Corporation`_. It has since gathered an active community of over two
  71. dozen contributors.
  72. .. _Apache Zookeeper: http://zookeeper.apache.org/
  73. .. _Zookeeper Programmers Guide: http://zookeeper.apache.org/doc/trunk/zookeeperProgrammers.html
  74. .. _Zookeeper Recipes: http://zookeeper.apache.org/doc/current/recipes.html#sc_recoverableSharedLocks
  75. .. _Nimbus Project: http://www.nimbusproject.org/
  76. .. _Zope Corporation: http://zope.com/
  77. .. _Mozilla: http://www.mozilla.org/
  78. .. _Netflix Curator: https://github.com/Netflix/curator
  79. .. _gevent: http://gevent.org/