Merge branch 'main' into uv

Author: bbayles

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/requirements"
+    schedule:
+      interval: "monthly"
+  - package-ecosystem: "pip"
+    directory: "/docs"
+    schedule:
+      interval: "monthly"

.github/workflows/build.yml

@@ -16,50 +16,67 @@ on:
     types:
       - published
 
+env:
+  PIP_BREAK_SYSTEM_PACKAGES: 1
+
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
 jobs:
   build_wheels:
     strategy:
+      fail-fast: false
       matrix:
         os: ["ubuntu-latest", "macos-latest", "windows-latest"]
 
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - run: make ci_requirements
     - name: Set up QEMU  # Needed to build aarch64 wheels
       if: runner.os == 'Linux'
-      uses: docker/setup-qemu-action@v2
+      uses: docker/setup-qemu-action@v3
       with:
         platforms: all
-    - uses: pypa/cibuildwheel@v2.16.5
-    - uses: actions/upload-artifact@v3
+    - uses: pypa/cibuildwheel@v2.22.0
+    - uses: actions/upload-artifact@v4
       with:
+        name: artifact-wheel-${{ matrix.os }}
         path: wheelhouse/*.whl
 
   make_sdist:
     runs-on: "ubuntu-latest"
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - run: |
         make ci_requirements
         python -m build --no-isolation --sdist
-    - uses: actions/upload-artifact@v3
+    - uses: actions/upload-artifact@v4
       with:
+        name: artifact-sdist
         path: dist/*.tar.gz
 
-  upload_all:
+  merge:
+    runs-on: ubuntu-latest
     needs: [build_wheels, make_sdist]
+    steps:
+      - name: Merge Artifacts
+        uses: actions/upload-artifact/merge@v4
+        with:
+          name: artifact
+          pattern: artifact-*
+          delete-merged: true
+
+  upload_all:
+    needs: merge
     runs-on: "ubuntu-latest"
     environment: release
     if: github.event_name == 'release' && github.event.action == 'published'
     permissions:
       id-token: write
     steps:
-    - uses: actions/download-artifact@v3
+    - uses: actions/download-artifact@v4
       with:
         name: artifact
         path: dist

.github/workflows/lint.yml

@@ -21,11 +21,11 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
-        python-version: "3.8"
+        python-version: "3.9"
     - name: Install dependencies
       run: |
         make requirements

.github/workflows/unit-tests.yml

@@ -16,21 +16,26 @@ on:
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
+
+
+env:
+  MACOSX_DEPLOYMENT_TARGET: "10.15"
 
 jobs:
   build_test:
     strategy:
+      fail-fast: false
       matrix:
-        os: ["ubuntu-20.04", "macos-11"]
+        os: ["ubuntu-latest", "macos-latest"]
 
     runs-on: ${{ matrix.os }}
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python 3.8
-      uses: actions/setup-python@v4
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v5
       with:
-        python-version: "3.8"
+        python-version: "3.9"
     - name: Install dependencies
       run: |
         make requirements

MANIFEST.in

@@ -0,0 +1,5 @@
+include ada_url/*.c
+include ada_url/*.cpp
+include ada_url/*.h
+exclude ada_url/*.o
+exclude ada_url/_ada_wrapper.*

Makefile

@@ -6,16 +6,15 @@ ci_requirements:
 .PHONY: requirements
 requirements:
 	python3 -m pip install uv
-	python3 -m uv pip install -r requirements/development.txt
+	python -m uv pip install -U -r requirements/development.txt ${req_args}
 
 .PHONY: check
 check:
-	black --check .
-	ruff .
+	ruff check .
 
 .PHONY: format
 format:
-	black .
+	ruff format .
 
 .PHONY: coverage
 coverage:
@@ -38,11 +37,7 @@ clean:
 	$(RM) ada_url/_ada_wrapper.abi3.so
 	$(RM) ada_url/ada.o
 
-.PHONY: c_lib
-c_lib:
-	$(CXX) -c "ada_url/ada.cpp" -fPIC -std="c++17" -O2 -o "ada_url/ada.o" $(ARCHFLAGS)
-
 .PHONY: package
-package: c_lib
+package:
 	python -m build --no-isolation
 	twine check dist/*

README.rst

@@ -1,7 +1,10 @@
 ada-url
 ========
 
-This is ``ada_url``, a Python library for working with URLs based on the ``Ada`` URL
+The `urlib.parse` module in Python does not follow the legacy RFC 3978 standard nor
+does it follow the newer WHATWG URL specification. It is also relatively slow.
+
+This is ``ada_url``, a fast standard-compliant Python library for working with URLs based on the ``Ada`` URL
 parser.
 
 * `Documentation <https://ada-url.readthedocs.io>`__
@@ -134,3 +137,12 @@ Contrast that with the Python standard library's ``urlib.parse`` module:
     'www.googlé.com'
     >>> parsed_url.path
     '/./path/../path2/'
+
+Alternative Python bindings
+---------------------------
+
+This package uses `CFFI <https://github.com/ada-url/ada-python/>`__ to call
+the ``Ada`` library's functions, which has a performance cost.
+The alternative `can_ada <https://github.com/tktech/can_ada>`__ (Canadian Ada)
+package uses `pybind11 <https://pybind11.readthedocs.io/en/stable/>`__ to generate a
+Python extension module, which is more performant.