PageRenderTime 40ms CodeModel.GetById 16ms RepoModel.GetById 0ms app.codeStats 0ms

/README.rst

https://bitbucket.org/excieve/pyhs/
ReStructuredText | 86 lines | 62 code | 24 blank | 0 comment | 0 complexity | 1de7202ba57a5b22e8116241c6dacd68 MD5 | raw file
Possible License(s): MIT 
    

  1. ====
    2. 

  2. pyhs
    3. 

  3. ====
    4. 

  4. 

  5. Overview
    6. 

  6. --------
    7. 

  7. 

  8. pyhs (python-handler-socket) is a Python client library for the
    9. 

  9. `HandlerSocket <https://github.com/ahiguti/HandlerSocket-Plugin-for-MySQL/>`_
    10. 

  10. MySQL plugin.
    11. 

  11. 

  12. Installation
    13. 

  13. ------------
    14. 

  14. 

  15. First, install MySQL and HandlerSocket. Some of the client's functionality
    16. 

  16. depends on latest revisions of the plugin so keep it up to date.
    17. 

  17. 

  18. After that, get the distribution::
    19. 

  19.     
    20. 

  20.     pip install python-handler-socket
    21. 

  21. 

  22. Or get the package from latest source::
    23. 

  23. 

  24.     pip install hg+http://bitbucket.org/excieve/pyhs#egg=python-handler-socket
    25. 

  25. 

  26. Or clone the main repository and install manually::
    27. 

  27. 

  28.     hg clone http://bitbucket.org/excieve/pyhs
    29. 

  29.     cd pyhs
    30. 

  30.     python setup.py install
    31. 

  31. 

  32. Check your installation like this::
    33. 

  33. 

  34.     python
    35. 

  35.     >>> from pyhs import __version__
    36. 

  36.     >>> print __version__
    37. 

  37. 

  38. Usage
    39. 

  39. -----
    40. 

  40. 

  41. Usage cases, details and API reference are available
    42. 

  42. in ``docs`` directory inside the package or
    43. 

  43. `online <http://python-handler-socket.readthedocs.org/>`_ on RTD.
    44. 

  44. 

  45. Changelog
    46. 

  46. ---------
    47. 

  47. 

  48. 0.2.4
    49. 

  49. ~~~~~
    50. 

  50. - Fixed infinite loop caused by remotely closed connection.
    51. 

  51. - Fixed incorrect Unicode chars escaping/unescaping in C speedups.
    52. 

  52. - Fixed indexes and caches might not be cleaned on connection errors.
    53. 

  53. - Somewhat refactored error recovery code.
    54. 

  54. 

  55. 0.2.3
    56. 

  56. ~~~~~
    57. 

  57. - Fixed single result single-column responses. Fixes issue #1 for real now, I hope.
    58. 

  58. 

  59. 0.2.2
    60. 

  60. ~~~~~
    61. 

  61. - Fixed incorrect behavior with single columns responses.
    62. 

  62. - Changed return value of ``find_modify`` calls with ``return_original=True`` to a list of rows of (field, value) tuples instead of a flat list of values.
    63. 

  63. 

  64. 0.2.1
    65. 

  65. ~~~~~
    66. 

  66. - Implemented optimised C versions of ``encode`` and ``decode``.
    67. 

  67. - Modified installation script to include optional building of C speedups module.
    68. 

  68. 

  69. 0.2.0
    70. 

  70. ~~~~~
    71. 

  71. - Added "incr" and "decr" operations support to the ``find_modify`` call.
    72. 

  72. - Added increment and decrement methods to the ``Manager`` class.
    73. 

  73. - Added original value result for all ``find_modify`` operations.
    74. 

  74. - Optimised query string encoding function.
    75. 

  75. 

  76. 0.1.0
    77. 

  77. ~~~~~
    78. 

  78. - Initial release.
    79. 

  79. 

  80. License
    81. 

  81. -------
    82. 

  82. 

  83. | pyhs is released under MIT license.
    84. 

  84. | Copyright (c) 2010 Artem Gluvchynsky <excieve@gmail.com>
    85. 

  85. 

  86. See ``LICENSE`` file inside the package for full licensing information.
    87. 

  87.