ARROW-215 Add tox config (#195)

* ARROW-215 Add tox config

Author: blink1073

.github/workflows/benchmark.yml

@@ -32,42 +32,36 @@ jobs:
         uses: supercharge/[email protected]
         with:
           mongodb-version: 6.0
-      - name: Install libbson
+      - name: Install tox
         run: |
-          LIBBSON_INSTALL_DIR=$(pwd)/libbson ./build-libbson.sh
-      - name: Install Python dependencies
+          python -m pip install tox
+      - name: Install libbson
         run: |
-          python -m pip install -U pip
-          python -m pip install asv virtualenv
+          tox -e build-libbson
 
       - name: Run benchmarks
         run: |
           set -eux
           run_asv () {
-              if [ ! -e "asv.conf.json" ] ; then
-                  git checkout refs/bm/pr asv.conf.json
-                  git checkout refs/bm/pr benchmarks/__init__.py
-                  git checkout refs/bm/pr benchmarks/benchmarks.py
+              if [ ! -e "tox.ini" ] ; then
+                  git checkout refs/bm/pr tox.ini
               fi
               git show --no-patch --format="%H (%s)"
-              asv run -e --python=`which python` --set-commit-hash $(git rev-parse HEAD)
+              export LIBBSON_INSTALL_DIR=$(pwd)/libbson
+              tox -e benchmark -- --set-commit-hash $(git rev-parse HEAD)
           }
 
+          pip install asv
           asv machine --yes
           git fetch origin main:main
           git update-ref refs/bm/pr HEAD
           # We know this is a PR run. The branch is a GitHub refs/pull/*/merge ref, so
           # the current target that this PR will be merged into is HEAD^1.
           git update-ref refs/bm/merge-target $(git log -n 1 --pretty=format:"%H" main --)
           git checkout --force refs/bm/pr --
-          # Install the library
-          LIBBSON_INSTALL_DIR=$(pwd)/libbson python -m pip install -e ".[test]"
           run_asv
 
-
           git checkout --force refs/bm/merge-target --
-          # Install the library
-          LIBBSON_INSTALL_DIR=$(pwd)/libbson python -m pip install -e ".[test]"
           run_asv
 
       - name: Compare benchmarks

.github/workflows/release-python.yml

@@ -116,14 +116,17 @@ jobs:
           # Build sdist on lowest supported Python
           python-version: '3.8'
 
+      - name: Install tox
+        run: |
+          python -m pip install tox
+
       - name: Build SDist
         working-directory: ./bindings/python
         run: |
           set -ex
-          python -m pip install -U pip build
           export LIBBSON_INSTALL_DIR="$(pwd)/libbson"
-          ./build-libbson.sh
-          python -m build --sdist .
+          tox -e build-libbson
+          tox -e build-dist -- --sdist
 
       - name: Test Sdist
         working-directory: ./bindings/python

.github/workflows/test-python.yml

@@ -69,31 +69,22 @@ jobs:
           mongod --remove
           mongod --install --dbpath=$(pwd)/data --logpath=$PWD/mongo.log
           net start MongoDB
-      - name: Install libbson
-        run: |
-          pip install packaging  # needed for mongo-c-driver-1.24.4/build/calc_release_version.py
-          pip install setuptools  # needed for use of distutils
-          ./build-libbson.sh
-      - name: Install Python dependencies
+      - name: Install tox
         run: |
-          python -m pip install -U pip
-      - name: Install pymongoarrow
+          python -m pip install tox
+      - name: Install libbson
         run: |
-          # Install the library with no deps
-          python -m pip install -v -e "."
+          tox -e build-libbson
       - name: Ensure imports with no test deps
         run: |
-          python -c "from pymongoarrow.monkey import patch_all; patch_all()"
-      - name: Install the test dependencies
-        run: |
-          python -m pip install -v -e ".[test]"
+          echo "LIBBSON_INSTALL_DIR=$LIBBSON_INSTALL_DIR"
+          tox -e import-check
       - name: Run the tests
         run: |
-          PYTHONWARNINGS=error python -m pytest -s -vv
+          tox -e test
       - name: Check the manifest
         run: |
-          pip install check-manifest
-          check-manifest -v
+          tox -e manifest
 
   docs:
     runs-on: ubuntu-latest
@@ -105,17 +96,14 @@ jobs:
           python-version: 3.9
           cache: 'pip'
           cache-dependency-path: '**/pyproject.toml'
-      - name: Install lib
-        shell: bash -l {0}
+      - name: Install tox
         run: |
-          NO_EXT=1 pip install .[docs]
-      - name: Build docs with warnings
+          python -m pip install tox
+      - name: Build docs
         shell: bash -l {0}
         run: |
-          pushd docs
-          make html SPHINXOPTS="-W"
+          NO_EXT=1 tox -e docs
       - name: Run linkcheck
         shell: bash -l {0}
         run: |
-          pushd docs
-          make linkcheck
+          NO_EXT=1 tox -e linkcheck

.readthedocs.yaml

@@ -4,7 +4,8 @@ build:
   tools:
     python: "3.9"
   commands:
-    - NO_EXT=1 pip install ./bindings/python[docs]
+    - NO_EXT=1 pip install ./bindings/python
+    - pip install -r ./bindings/python/docs/docs-requirements.txt
     - mkdir --parents $READTHEDOCS_OUTPUT/html/
     - cd ./bindings/python/docs && make html
     - cp --recursive ./bindings/python/docs/build/html/* $READTHEDOCS_OUTPUT/html/

bindings/python/MANIFEST.in

@@ -2,6 +2,7 @@ include README.md
 include LICENSE
 include *.sh
 include pyproject.toml
+include tox.ini
 
 exclude THIRD-PARTY-NOTICES
 exclude addtags.py

bindings/python/build-libbson.sh

@@ -20,13 +20,14 @@ then
 fi
 
 echo "Installing libbson..."
-
+DEFAULT_ARCH=$(uname -m)
 MACOSX_DEPLOYMENT_TARGET=${MACOSX_DEPLOYMENT_TARGET:-"10.15"}
-CMAKE_OSX_ARCHITECTURES=${CMAKE_OSX_ARCHITECTURES:-"x86_64"}
+CMAKE_OSX_ARCHITECTURES=${CMAKE_OSX_ARCHITECTURES:-${DEFAULT_ARCH}}
 CMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE:-"Debug"}
 
 # Directory where build artifacts will be placed
-LIBBSON_INSTALL_DIR=${LIBBSON_INSTALL_DIR:-""}
+DEFAULT_INSTALL_DIR=$(pwd)/libbson
+LIBBSON_INSTALL_DIR=${LIBBSON_INSTALL_DIR:-${DEFAULT_INSTALL_DIR}}
 
 # Replace a relative path with an absolute one for cmake
 LIBBSON_INSTALL_DIR="$(cd "$(dirname "$LIBBSON_INSTALL_DIR")"; pwd)/$(basename "$LIBBSON_INSTALL_DIR")"

bindings/python/cibw_before_build.sh

@@ -15,11 +15,15 @@ then
     export CMAKE_OSX_ARCHITECTURES="arm64"
   else
     platform="macosx_10_14_x86_64"
+    export CMAKE_OSX_ARCHITECTURES="x86_64"
   fi
 
   # Install pyarrow with the appropriate platform.
   pip install --platform $platform --upgrade --target $HOME/wheels --no-deps --only-binary=:all: pyarrow
 fi
 
+# Install tox, needed for the build command.
+pip install tox
+
 # Build libbson with the appropriate arch.
-CMAKE_BUILD_TYPE=Release ./build-libbson.sh
+CMAKE_BUILD_TYPE=Release tox -e build-libbson

bindings/python/docs/docs-requirements.txt

@@ -0,0 +1,4 @@
+sphinx>=5.3,<8
+sphinx_rtd_theme>=2,<3
+sphinxcontrib-shellcheck>=1,<2
+furo==2023.9.10

bindings/python/docs/source/developer/benchmarks.rst

@@ -10,3 +10,7 @@ To run the benchmarks, you need the `asv <https://pypi.org/project/asv/>`_ packa
 which can then be invoked like so::
 
   $ asv run --strict --python=`which python`
+
+or you can run with tox as:
+
+  $ tox -e benchmarks

bindings/python/docs/source/developer/installation.rst

@@ -29,6 +29,7 @@ from sources::
 
   $ virtualenv pymongoarrow
   $ source ./pymongoarrow/bin/activate
+  $ pip install tox
 
 libbson
 ^^^^^^^
@@ -41,7 +42,7 @@ Detailed instructions for building/installing ``libbson`` can be found
 You can either use a system-provided version of ``libbson`` that is properly
 configured for use with ``pkg-config``, or use the provided ``build-libbson.sh`` script to build it::
 
-  $ LIBBSON_INSTALL_DIR=$(pwd)/libbson ./build-libbson.sh
+  $ LIBBSON_INSTALL_DIR=$(pwd)/libbson tox -e build-libbson
 
 On macOS, users can install the latest ``libbson`` using Homebrew::
 
@@ -57,22 +58,29 @@ If you try to build with a lower version a ``ValueError`` will be raised.
 Build
 -----
 
-In the previously created virtualenv, install PyMongoArrow and its test dependencies in editable mode::
+Typically we will use the provided ``tox`` scripts and will not build directly, but you can build and
+test in the created virtualenv.
+
+In the previously created virtualenv, to install PyMongoArrow and its test dependencies in editable mode::
 
   (pymongoarrow) $ pip install -v -e ".[test]"
 
 If you built libbson using the ``build-libbson`` script then use the same ``LIBBSON_INSTALL_DIR`` as above:
 
   (pymongoarrow) $ LIBBSON_INSTALL_DIR=$(pwd)/libbson pip install -v -e ".[test]"
 
-
 Test
 ----
 
 To run the test suite, you will need a MongoDB instance running on
 ``localhost`` using port ``27017``. To run the entire test suite, do::
 
-  (pymongoarrow) $ python -m pytest
+  (pymongoarrow) $ tox -e test
+
+or, if not using ``tox``:
+
+  (pymongoarrow) $ pytest
+
 
 Running Linters
 ---------------
@@ -84,9 +92,9 @@ that help follow a consistent code style within the codebase.
 
 To set up ``pre-commit`` locally, run::
 
-    pip install pre-commit
-    pre-commit install
+    (pymongoarrow) $ pip install pre-commit
+    (pymongoarrow) $ pre-commi t install
 
 To run ``pre-commit`` manually, run::
 
-    pre-commit run --all-files
+    (pymongoarrow) $ tox -e lint