INTPYTHON-592 Convert to use just and uv (#298)

Author: blink1073

.github/workflows/benchmark.yml

@@ -34,23 +34,20 @@ jobs:
         uses: supercharge/[email protected]
         with:
           mongodb-version: 6.0
-      - name: Install tox
+      - name: Install deps
         run: |
-          python -m pip install tox
+          python -m pip install rust-just uv
       - name: Install libbson
         run: |
-          tox -e build-libbson
+          just build-libbson
 
       - name: Run benchmarks
         run: |
           set -eux
           run_asv () {
-              if [ ! -e "tox.ini" ] ; then
-                  git checkout refs/bm/pr tox.ini
-              fi
               git show --no-patch --format="%H (%s)"
               export LIBBSON_INSTALL_DIR=$(pwd)/libbson
-              tox -e benchmark -- --set-commit-hash $(git rev-parse HEAD)
+              just benchmark --set-commit-hash $(git rev-parse HEAD)
           }
 
           pip install asv virtualenv

.github/workflows/dist-python.yml

@@ -77,8 +77,8 @@ jobs:
         if: runner.os == 'macOS'
         run: brew install pkg-config
 
-      - name: Install cibuildwheel
-        run: python -m pip install "cibuildwheel>=2.4,<3"
+      - name: Install deps
+        run: python -m pip install "cibuildwheel>=2.4,<3" uv rust-just
 
       - name: Build MacOS Py39 Wheels
         if: ${{ matrix.python == 'cp39' && matrix.buildplat[0] == 'macos-11' }}
@@ -114,22 +114,21 @@ jobs:
           # Build sdist on lowest supported Python
           python-version: '3.9'
 
-      - name: Install tox
+      - name: Install deps
         run: |
-          python -m pip install tox
+          python -m pip install rust-just uv build
 
       - name: Build SDist
         working-directory: ./bindings/python
         run: |
-          set -ex
-          export LIBBSON_INSTALL_DIR="$(pwd)/libbson"
-          tox -e build-libbson
-          tox -e build-dist -- --sdist
+          export LIBBSON_INSTALL_DIR=$(pwd)/libbson
+          just build-libbson
+          python -m build --sdist .
 
       - name: Test Sdist
         working-directory: ./bindings/python
         run: |
-          export LIBBSON_INSTALL_DIR="$(pwd)/libbson"
+          export LIBBSON_INSTALL_DIR=$(pwd)/libbson
           python -m pip install dist/*.gz
           cd ..
           python -c "from pymongoarrow.lib import libbson_version"

.github/workflows/release-python.yml

@@ -51,15 +51,13 @@ jobs:
           aws_region_name: ${{ vars.AWS_REGION_NAME }}
           aws_secret_id: ${{ secrets.AWS_SECRET_ID }}
           artifactory_username: ${{ vars.ARTIFACTORY_USERNAME }}
-      - name: Install tox
+      - name: Install Deps
         run: |
-          python -m pip install tox
+          python -m pip install rust-just uv
       - name: Build Libbson
         working-directory: ./bindings/python
         run: |
-          set -ex
-          export LIBBSON_INSTALL_DIR="$(pwd)/libbson"
-          tox -e build-libbson
+          just build-libbson
           echo "LIBBSON_INSTALL_DIR=$LIBBSON_INSTALL_DIR" >> $GITHUB_ENV
       - uses: mongodb-labs/drivers-github-tools/python-labs/pre-publish@v2
         id: pre-publish

.github/workflows/test-python.yml

@@ -16,18 +16,20 @@ defaults:
 
 jobs:
 
-  pre-commit:
-    name: pre-commit
+  lint:
+    name: lint
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
         with:
           persist-credentials: false
       - uses: actions/setup-python@v5
-      - uses: pre-commit/[email protected]
-        with:
-          extra_args: --all-files --hook-stage=manual
+      - name: Install Deps
+        run: |
+          python -m pip install rust-just uv
+      - name: Run linter
+        run: just lint
 
   build:
     # supercharge/mongodb-github-action requires containers so we don't test other platforms
@@ -76,22 +78,15 @@ jobs:
           mongod --remove
           mongod --install --dbpath=$(pwd)/data --logpath=$PWD/mongo.log
           net start MongoDB
-      - name: Install tox
+      - name: Install Deps
         run: |
-          python -m pip install tox
+          python -m pip install rust-just uv
       - name: Install libbson
-        run: |
-          tox -e build-libbson
+        run: just build-libbson
       - name: Ensure imports with no test deps
-        run: |
-          echo "LIBBSON_INSTALL_DIR=$LIBBSON_INSTALL_DIR"
-          tox -e import-check
+        run: just import-check
       - name: Run the tests
-        run: |
-          tox -e test
-      - name: Check the manifest
-        run: |
-          tox -e manifest
+        run: just test
 
   docs:
     runs-on: ubuntu-latest
@@ -105,14 +100,10 @@ jobs:
           python-version: 3.9
           cache: 'pip'
           cache-dependency-path: '**/pyproject.toml'
-      - name: Install tox
+      - name: Install Deps
         run: |
-          python -m pip install tox
+          python -m pip install rust-just uv
       - name: Build docs
-        shell: bash -l {0}
-        run: |
-          NO_EXT=1 tox -e docs
+        run: just docs
       - name: Run linkcheck
-        shell: bash -l {0}
-        run: |
-          NO_EXT=1 tox -e linkcheck
+        run: just docs-linkcheck

.readthedocs.yaml

@@ -2,10 +2,14 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.9"
-  commands:
-    - 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/
+    python: "3.11"
+  jobs:
+    create_environment:
+        - asdf plugin add uv
+        - asdf install uv latest
+        - asdf global uv latest
+    install:
+        - cd bindings/python && uv sync --no-install-project --group docs
+    build:
+        html:
+          - cd bindings/python && uv run --no-project sphinx-build -c docs -T -b html docs $READTHEDOCS_OUTPUT/html

bindings/python/CONTRIBUTING.md

@@ -25,7 +25,7 @@ PyMongoArrow uses [Ruff](https://docs.astral.sh/ruff/) for formatting and lintin
 -   Avoid backward breaking changes if at all possible.
 -   Write inline documentation for new classes and methods.
 -   Write tests and make sure they pass (make sure you have a mongod
-    running on the default port, then execute `tox -e test` from the cmd
+    running on the default port, then execute `just test` from the cmd
     line to run the test suite).
 -   Add yourself to doc/contributors.rst `:)`
 
@@ -144,18 +144,16 @@ Windows is not yet supported.
 
 First, clone the mongo-arrow git repository:
 
-``` bash
-$ git clone https://github.com/mongodb-labs/mongo-arrow.git
-$ cd mongo-arrow/bindings/python
+```bash
+git clone https://github.com/mongodb-labs/mongo-arrow.git
+cd mongo-arrow/bindings/python
 ```
 
-Additionally, create a virtualenv in which to install `pymongoarrow`
-from sources:
+Ensure you have [just](https://just.systems/man/en/introduction.html) and [uv](https://docs.astral.sh/uv/getting-started/installation/) installed.
+Then run:
 
-``` bash
-$ virtualenv pymongoarrow
-$ source ./pymongoarrow/bin/activate
-$ pip install tox
+```bash
+just install
 ```
 
 ### libbson
@@ -170,7 +168,7 @@ properly configured for use with `pkg-config`, or use the provided
 `build-libbson.sh` script to build it:
 
 ``` bash
-$ LIBBSON_INSTALL_DIR=$(pwd)/libbson tox -e build-libbson
+just build-libbson
 ```
 
 On macOS, users can install the latest `libbson` using Homebrew:
@@ -190,14 +188,14 @@ you try to build with a lower version a `ValueError` will be raised.
 
 ## Build
 
-Typically we will use the provided `tox` scripts and will not build
+Typically we will use the provided `just` 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:
 
-``` bash
-(pymongoarrow) $ pip install -v -e ".[test]"
+```bash
+pip install -v -e ".[test]"
 ```
 
 If you built libbson using the `build-libbson` script then use the same
@@ -211,11 +209,11 @@ If you built libbson using the `build-libbson` script then use the same
 To run the test suite, you will need a MongoDB instance running on
 `localhost` using port `27017`. To run the entire test suite, do:
 
-``` bash
-(pymongoarrow) $ tox -e test
+```bash
+just test
 ```
 
-or, if not using `tox`:
+or, if not using `just`:
 
 > (pymongoarrow) \$ pytest
 
@@ -228,15 +226,14 @@ consistent code style within the codebase.
 
 To set up `pre-commit` locally, run:
 
-``` bash
-(pymongoarrow) $ pip install pre-commit
-(pymongoarrow) $ pre-commit install
+```bash
+just install
 ```
 
 To run `pre-commit` manually, run:
 
-``` bash
-(pymongoarrow) $ tox -e lint
+```bash
+just lint
 ```
 
 ## Running Benchmarks
@@ -246,12 +243,12 @@ To run `pre-commit` manually, run:
 To run the benchmarks, you need the [asv](https://pypi.org/project/asv/)
 package, which can then be invoked like so:
 
-``` bash
+```bash
 asv run --strict --python=`which python`
 ```
 
-or you can run with tox as:
+or you can run with just as:
 
-``` bash
-tox -e benchmarks
+```bash
+just benchmark
 ```

bindings/python/MANIFEST.in

@@ -5,10 +5,11 @@ include LICENSE
 include THIRD-PARTY-NOTICES
 include *.sh
 include pyproject.toml
-include tox.ini
 
 exclude RELEASE.md
 exclude asv.conf.json
+exclude uv.lock
+exclude justfile
 
 graft pymongoarrow
 

bindings/python/build-libbson.sh

@@ -36,6 +36,13 @@ echo "MACOSX_DEPLOYMENT_TARGET=${MACOSX_DEPLOYMENT_TARGET}"
 echo "CMAKE_OSX_ARCHITECTURES=${CMAKE_OSX_ARCHITECTURES}"
 echo "LIBBSON_INSTALL_DIR=${LIBBSON_INSTALL_DIR}"
 
+# Activate the virtualenv for the cmake build.
+if [ -d "$(pwd)/.venv/Scripts" ]; then
+  . "$(pwd)/.venv/Scripts/activate"
+else
+  . "$(pwd)/.venv/bin/activate"
+fi
+
 # Build libbson
 pushd "$WORKDIR"
   git checkout "$LIBBSON_VERSION"

bindings/python/cibw_before_build.sh

@@ -22,8 +22,8 @@ then
   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
+# Install just uv, needed for the build command.
+pip install rust-just uv
 
 # Build libbson with the appropriate arch.
-CMAKE_BUILD_TYPE=Release tox -e build-libbson
+CMAKE_BUILD_TYPE=Release just build-libbson