From 34f0417dc97cc6d0d44e1a58b90734dcffd9f315 Mon Sep 17 00:00:00 2001 From: Arthur Hamon Date: Thu, 13 Jun 2019 15:51:28 +0200 Subject: [PATCH] add troubleshooting in contributing section When I ran the test suite on macOSX, I had some issues regarding SSL configuration, I have documented the error I encounter and the solution to deal with it. --- docs/contributing.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/contributing.rst b/docs/contributing.rst index f5ffc84..63865a6 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -23,3 +23,24 @@ documentation `__ for how to set this up. I have marked the boto tests as optional in Travis so you don't have to worry about them failing if you submit a pull request. + + +Troubleshooting on MacOSX +------------------------- + +If you have this kind of error when running tox : + +.. code:: python + + __main__.ConfigurationError: Curl is configured to use SSL, but we have + not been able to determine which SSL backend it is using. Please see PycURL documentation for how to specify the SSL backend manually. + +Then you need to define some environment variables: + +.. code:: bash + + export PYCURL_SSL_LIBRARY=openssl + export LDFLAGS=-L/usr/local/opt/openssl/lib + export CPPFLAGS=-I/usr/local/opt/openssl/include + +Reference : `stackoverflow issue `__