Skip to content
Newer
Older
100644 111 lines (79 sloc) 3.24 KB
45f2c4c @lericson Streamline README documentation.
authored
1 `pylibmc` is a quick and small Python client for memcached__ written in C.
4fc4399 @lericson Split readme to own file.
authored
2
45f2c4c @lericson Streamline README documentation.
authored
3 __ http://memcached.org/
4fc4399 @lericson Split readme to own file.
authored
4
9b4f669 @lericson Typofix.
authored
5 It builds on the famous `libmemcached`__ C client from TangentOrg__, notable for
45f2c4c @lericson Streamline README documentation.
authored
6 its speed and flexibility.
7
8 __ http://tangent.org/552/libmemcached.html
9 __ http://tangent.org/
10
11 `libmemcached` must be installed separately, and be available to the compiler
12 and linker.
13
59025f4 @lericson Make documentation reference actual location.
authored
14 For usage and documentation, see pylibmc__'s home.
4fc4399 @lericson Split readme to own file.
authored
15
59025f4 @lericson Make documentation reference actual location.
authored
16 __ http://sendapatch.se/projects/pylibmc/
f51b633 @lericson Pretty up the ReST documentation a little.
authored
17
4fc4399 @lericson Split readme to own file.
authored
18 Comparison to other libraries
19 =============================
20
21 Why use `pylibmc`? Because it's fast.
22
e88e96b @lericson Add more references for comparison.
authored
23 `See this (a bit old) speed comparison`__, or `amix.dk's comparison`__.
4fc4399 @lericson Split readme to own file.
authored
24
e88e96b @lericson Add more references for comparison.
authored
25 __ http://lericson.blogg.se/code/2008/november/pylibmc-051.html
26 __ http://amix.dk/blog/viewEntry/19471
6396b95 @lericson Add note about IRC channel.
authored
27
587df71 @lericson Add notes on installation options.
authored
28 Installation
29 ============
30
31 Building needs libmemcached and optionally zlib, the path to which can be
32 specified using command-line options to ``setup.py``
33
34 ``--with-libmemcached=DIR``
35 Build against libmemcached in DIR
36 ``--with-zlib=DIR``
37 Build against zlib in DIR
38 ``--without-zlib``
39 Disable zlib (disables compression)
40
41 So for example, if one were to use MacPorts to install libmemcached, your
42 libmemcached would end up in ``/opt/local``, hence
43 ``--with-libmemcached=/opt/local``.
44
6396b95 @lericson Add note about IRC channel.
authored
45 IRC
46 ===
47
48 ``#sendapatch`` on ``chat.freenode.net``.
49
4fc4399 @lericson Split readme to own file.
authored
50 Change Log
51 ==========
52
3702d07 @lericson Add changelog for 1.0
authored
53 New in version 1.0
54 ------------------
55
56 - Lots of documentation fixes and other nice things like that.
57 - Nailed what appears to be the last outstanding memory leak.
58
f5b756d @lericson Add 0.9 changes.
authored
59 New in version 0.9
60 ------------------
61
62 - Added a ``get_stats`` method, which behaves exactly like
63 `python-memcached`'s equivalent.
529adbe @lericson Add note about empty values as empty strings.
authored
64 - Gives the empty string for empty memcached values like `python-memcached`
65 does.
6a9ad74 @lericson Add note about per-rc exceptions to changelog.
authored
66 - Added exceptions for most `libmemcached` return codes.
7112d17 @lericson Add notes about 0.9.3 fixes.
authored
67 - Fixed an issue with ``Client.behaviors.update``.
f5b756d @lericson Add 0.9 changes.
authored
68
7773d83 @lericson Add what is new in 0.8 section.
authored
69 New in version 0.8
70 ------------------
71
72 - Pooling helpers are now available. See ``pooling.rst`` in the distribution.
018a46d @lericson Add news on the binary support.
authored
73 - The binary protocol is now properly exposed, simply pass ``binary=True`` to
74 the constructor and there you go.
7773d83 @lericson Add what is new in 0.8 section.
authored
75 - Call signatures now match `libmemcached` 0.32, but should work with older
76 versions. Remember to run the tests!
77
ccf7b8c @lericson Prepare pylibmc 0.7.
authored
78 New in version 0.7
79 ------------------
80
81 - Restructured some of the code, which should yield better performance (if not
82 for that, it reads better.)
83 - Fixed some memory leaks.
84 - Integrated changes from `amix.dk`, which should make pylibmc work under
85 Snow Leopard.
58cdf9c @lericson Note that boolean datatypes are now available.
authored
86 - Add support for the boolean datatype.
0c86366 @lericson Prepare release 0.7.2.
authored
87 - Improved test-runner -- now tests ``build/lib.*/_pylibmc.so`` if available,
88 and reports some version information.
ce9359f @lericson Prepare release 0.7.3.
authored
89 - Support for x86_64 should now work completely.
97597d0 @lericson Add more to the list of changes in 0.7.x
authored
90 - Builds with Python 2.4, tests run fine, but not officially supported.
91 - Fixed critical bugs in behavior manipulation.
ccf7b8c @lericson Prepare pylibmc 0.7.
authored
92
4fc4399 @lericson Split readme to own file.
authored
93 New in version 0.6
94 ------------------
95
f51b633 @lericson Pretty up the ReST documentation a little.
authored
96 - Added compatibility with `libmemcached` 0.26, WRT error return codes.
97 - Added `flush_all` and `disconnect_all` methods.
98 - Now using the latest pickling protocol.
4fc4399 @lericson Split readme to own file.
authored
99
100 New in version 0.5
101 ------------------
102
f51b633 @lericson Pretty up the ReST documentation a little.
authored
103 - Fixed lots of memory leaks, and added support for `libmemcached` 0.23.
23c2a1a @lericson Typofix pendatics -> pedantics.
authored
104 - Also made the code tighter in terms of compiler pedantics.
4fc4399 @lericson Split readme to own file.
authored
105
106 New in version 0.4
107 ------------------
108
f51b633 @lericson Pretty up the ReST documentation a little.
authored
109 - Renamed the C module to `_pylibmc`, and added lots of `libmemcached` constants
110 to it, as well as implemented behaviors.
Something went wrong with that request. Please try again.