Merge pull request #1648 from consideRatio/pr/update-pycurl-requireme…

…nt-handling

maint: refactoring around pycurl as an optional dependency

.github/workflows/test.yml

@@ -409,7 +409,7 @@ jobs:
       - name: Setup Python package dependencies
         run: |
           pip install -r dev-requirements.txt -r testing/local-binder-local-hub/requirements.txt
-          pip install .
+          pip install ".[pycurl]"
 
       - name: Setup JupyterHub NPM dependencies
         run: npm install -g configurable-http-proxy

dev-requirements.txt

@@ -7,7 +7,6 @@ jsonschema
 jupyter-repo2docker>=2021.08.0
 jupyter_packaging>=0.10.4,<2
 jupyterhub
-pycurl
 pytest
 pytest-asyncio
 pytest-cov

docs/source/contribute.md

@@ -123,7 +123,7 @@ continue.
    requirements locally.
 
    ```bash
-   python3 -m pip install -e . -r dev-requirements.txt
+   python3 -m pip install -e ".[pycurl]" -r dev-requirements.txt
    ```
 
 1. Install the JupyterHub Helm chart by itself into your Kubernetes cluster

helm-chart/images/binderhub/Dockerfile

@@ -29,9 +29,8 @@ ARG PIP_CACHE_DIR=/tmp/pip-cache
 RUN --mount=type=cache,target=${PIP_CACHE_DIR} \
     pip install build \
  && pip wheel --wheel-dir=/tmp/wheels \
-        . \
-        pycurl \
-        -r helm-chart/images/binderhub/requirements.txt
+        -r helm-chart/images/binderhub/requirements.txt \
+        .
 
 
 # The final stage
@@ -63,9 +62,8 @@ ARG PIP_CACHE_DIR=/tmp/pip-cache
 RUN --mount=type=cache,target=${PIP_CACHE_DIR} \
     --mount=type=cache,from=build-stage,source=/tmp/wheels,target=/tmp/wheels \
     pip install --find-links=/tmp/wheels/ \
-        binderhub \
-        pycurl \
-        -r /tmp/requirements.txt
+        -r /tmp/requirements.txt \
+        binderhub
 
 # verify success of previous step
 RUN python -c "import pycurl, binderhub.app"

helm-chart/images/binderhub/requirements.in

@@ -16,4 +16,10 @@ jupyterhub==3.*
 kubernetes==9.*
 
 # binderhub's dependencies
+#
+# We can't put ".[pycurl]" here directly as when we freeze this into
+# requirements.txt using ci/refreeze, its declaring "binderhub @ file:///io"
+# which is a problem as its an absolute path.
+#
+pycurl
 -r ../../../requirements.txt

helm-chart/images/binderhub/requirements.txt

@@ -126,6 +126,8 @@ pyasn1-modules==0.2.8
     # via google-auth
 pycparser==2.21
     # via cffi
+pycurl==7.45.2
+    # via -r helm-chart/images/binderhub/requirements.in
 pyjwt==2.6.0
     # via -r helm-chart/images/binderhub/../../../requirements.txt
 pyopenssl==23.1.1

requirements.txt

@@ -1,10 +1,3 @@
-# About pycurl:
-# - pycurl is an optional dependency which improves performance
-# - pycurl requires both `curl-config` and `gcc` to be available when installing
-#   it from source.
-# - the reason we do not list pycurl here is that it is not needed when our
-#   code is imported to generate the documentation and it is tricky to install
-#   in the ReadTheDocs build environment.
 docker
 escapism
 jinja2

setup.py

@@ -62,7 +62,13 @@
     include_package_data=True,
     install_requires=requirements,
     extras_require={
-        # optional dependency which improves performance
+        # pycurl is an optional dependency which improves performance
+        #
+        # - pycurl requires both `curl-config` and `gcc` to be available when
+        #   installing it from source.
+        # - pycurl should always be used in production, but it's not relevant
+        #   for building documentation which inspects the source code.
+        #
         "pycurl": ["pycurl"],
     },
 )