This repository has been archived on 2018-06-04. You can view files and clone it, but cannot push or open issues/pull-requests.
pylibmc/README.rst

127 lines
3.8 KiB
ReStructuredText
Raw Permalink Normal View History

2009-12-30 13:26:27 +00:00
`pylibmc` is a quick and small Python client for memcached__ written in C.
2009-07-31 20:19:25 +00:00
2009-12-30 13:26:27 +00:00
__ http://memcached.org/
2009-07-31 20:19:25 +00:00
2009-12-30 17:39:37 +00:00
It builds on the famous `libmemcached`__ C client from TangentOrg__, notable for
2009-12-30 13:26:27 +00:00
its speed and flexibility.
__ http://tangent.org/552/libmemcached.html
__ http://tangent.org/
`libmemcached` must be installed separately, and be available to the compiler
and linker.
2010-03-22 21:33:17 +00:00
For installation instructions, usage notes and reference documentation, see
pylibmc__'s home at http://sendapatch.se/projects/pylibmc/.
2009-07-31 20:19:25 +00:00
__ http://sendapatch.se/projects/pylibmc/
2009-07-31 20:19:25 +00:00
Comparison to other libraries
=============================
Why use `pylibmc`? Because it's fast.
`See this (a bit old) speed comparison`__, or `amix.dk's comparison`__.
2009-07-31 20:19:25 +00:00
__ http://lericson.blogg.se/code/2008/november/pylibmc-051.html
__ http://amix.dk/blog/viewEntry/19471
2009-08-16 15:10:17 +00:00
2010-01-18 14:19:46 +00:00
Installation
============
Building needs libmemcached and optionally zlib, the path to which can be
specified using command-line options to ``setup.py``
``--with-libmemcached=DIR``
Build against libmemcached in DIR
``--with-zlib=DIR``
Build against zlib in DIR
``--without-zlib``
Disable zlib (disables compression)
So for example, if one were to use MacPorts to install libmemcached, your
libmemcached would end up in ``/opt/local``, hence
``--with-libmemcached=/opt/local``.
2009-08-16 15:10:17 +00:00
IRC
===
``#sendapatch`` on ``chat.freenode.net``.
2009-07-31 20:19:25 +00:00
Change Log
==========
2010-06-03 14:43:16 +00:00
New in version 1.1
------------------
- Removed deprecated space-based behavior names.
- Acquire and release the GIL properly, thanks ketralnis__
- Add support for ``libmemcached 0.40``
- Included a more useful command-line interface
- Fixed handling of NUL-byte keys in ``get_multi`` in binary protocol
- Fixed some valgrind-reported memory warnings
- Fixed bogus usage of time argument for delete.
2010-06-07 14:06:00 +00:00
- 1.1.1: Fixed tests under Python 2.5
2010-06-03 14:43:16 +00:00
__ http://www.ketralnis.com/
2010-03-21 21:44:04 +00:00
New in version 1.0
------------------
- Lots of documentation fixes and other nice things like that.
- Nailed what appears to be the last outstanding memory leak.
- Explicitly require libmemcached 0.32 or newer.
2010-03-21 21:44:04 +00:00
2009-10-31 10:21:55 +00:00
New in version 0.9
------------------
- Added a ``get_stats`` method, which behaves exactly like
`python-memcached`'s equivalent.
- Gives the empty string for empty memcached values like `python-memcached`
does.
- Added exceptions for most `libmemcached` return codes.
- Fixed an issue with ``Client.behaviors.update``.
2009-10-31 10:21:55 +00:00
2009-09-21 13:37:35 +00:00
New in version 0.8
------------------
- Pooling helpers are now available. See ``pooling.rst`` in the distribution.
- The binary protocol is now properly exposed, simply pass ``binary=True`` to
the constructor and there you go.
- Call signatures now match `libmemcached` 0.32, but should work with older
versions. Remember to run the tests!
2009-09-21 13:37:35 +00:00
2009-09-07 00:29:35 +00:00
New in version 0.7
------------------
- Restructured some of the code, which should yield better performance (if not
for that, it reads better.)
- Fixed some memory leaks.
- Integrated changes from `amix.dk`, which should make pylibmc work under
Snow Leopard.
- Add support for the boolean datatype.
- Improved test-runner -- now tests ``build/lib.*/_pylibmc.so`` if available,
and reports some version information.
- Support for x86_64 should now work completely.
- Builds with Python 2.4, tests run fine, but not officially supported.
- Fixed critical bugs in behavior manipulation.
2009-09-07 00:29:35 +00:00
2009-07-31 20:19:25 +00:00
New in version 0.6
------------------
- Added compatibility with `libmemcached` 0.26, WRT error return codes.
- Added `flush_all` and `disconnect_all` methods.
- Now using the latest pickling protocol.
2009-07-31 20:19:25 +00:00
New in version 0.5
------------------
- Fixed lots of memory leaks, and added support for `libmemcached` 0.23.
- Also made the code tighter in terms of compiler pedantics.
2009-07-31 20:19:25 +00:00
New in version 0.4
------------------
- Renamed the C module to `_pylibmc`, and added lots of `libmemcached` constants
to it, as well as implemented behaviors.