Uploaded image for project: 'Couchbase Python Client Library'
  1. Couchbase Python Client Library
  2. PYCBC-558

better document lcb dependencies

    XMLWordPrintable

Details

    • Improvement
    • Status: Closed
    • Major
    • Resolution: Fixed
    • None
    • 2.5.4
    • docs
    • None

    Description

      In addition to what's mentioned under PYCBC-520, ensure the lcb dependencies are well documented in:

      • The README
      • The docs on the documentation site
      • The API reference information
      • The package manager metadata such as requirements.txt

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          ingenthr Matt Ingenthron created issue -
          ingenthr Matt Ingenthron made changes -
          Field Original Value New Value
          Description Python 2.4.0 onwards relies on Libcouchbase 2.9.0+, if you try to install Python 2.4.0 with an earlier Libcouchbase you get warnings about crypto methods:

          {noformat}
           src/crypto.c: In function 'pycbc_crypto_exc_wrap_v1_encrypt':
            src/crypto.c:708:42: error: 'union <anonymous>' has no member named 'v1'; did you mean 'v0'?
                     lcb_result = orig_lcb_provider->v.v1.encrypt(orig_lcb_provider,
                                                      ^
            src/crypto.c: In function 'pycbc_crypto_exc_wrap_v1_decrypt':
            src/crypto.c:742:42: error: 'union <anonymous>' has no member named 'v1'; did you mean 'v0'?
                     lcb_result = orig_lcb_provider->v.v1.decrypt(orig_lcb_provider,
                                                      ^
          {noformat}

          These errors are pretty cryptic unless you're in the know about what features were added to which SDK when.

          It would be a much better experience for everyone if any time we had to bump the minimum libcouchbase dependency we could have some installation-level check saying something like:

          {quote}
          Libcouchbase 2.9.0 required, version 2.8.2 found. Please update libcouchbase to a later version before installing this version of the Python SDK.
          {quote}

          This is a clear error message for the user, with clear instructions for how to resolve their issue.

          As an aside https://developer.couchbase.com/server/other-products/release-notes-archives/python-sdk does not cover the need for a minimum version of Libcouchbase.
          In addition to what's mentioned under PYCBC-520, ensure the lcb dependencies are well documented in:
          - The README
          - The docs on the documentation site
          - The
          ingenthr Matt Ingenthron made changes -
          Component/s docs [ 10119 ]
          Component/s library [ 10118 ]
          ingenthr Matt Ingenthron made changes -
          Description In addition to what's mentioned under PYCBC-520, ensure the lcb dependencies are well documented in:
          - The README
          - The docs on the documentation site
          - The
          In addition to what's mentioned under PYCBC-520, ensure the lcb dependencies are well documented in:
          - The README
          - The docs on the documentation site
          - The API reference information
          - The package manager metadata
          ingenthr Matt Ingenthron made changes -
          Description In addition to what's mentioned under PYCBC-520, ensure the lcb dependencies are well documented in:
          - The README
          - The docs on the documentation site
          - The API reference information
          - The package manager metadata
          In addition to what's mentioned under PYCBC-520, ensure the lcb dependencies are well documented in:
          - The README
          - The docs on the documentation site
          - The API reference information
          - The package manager metadata such as requirements.txt
          Ellis.Breen Ellis Breen made changes -
          Status New [ 10003 ] Open [ 1 ]
          Ellis.Breen Ellis Breen made changes -
          Status Open [ 1 ] In Progress [ 3 ]
          Ellis.Breen Ellis.Breen made changes -
          Actual Start 2019-01-08 05:51 (issue has been started)
          Ellis.Breen Ellis Breen made changes -
          Resolution Fixed [ 1 ]
          Status In Progress [ 3 ] Closed [ 6 ]
          Ellis.Breen Ellis.Breen made changes -
          Actual End 2019-02-05 13:28 (issue has been closed)

          People

            Ellis.Breen Ellis Breen
            matt.carabine Matt Carabine
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty