BREAKING: switch to uv, namespace package and Python 3.10+ (#57)

Author: hbredin

.gitattributes

@@ -1,2 +1 @@
-pyannote/pipeline/_version.py export-subst
 doc/source/conf.py export-subst

.github/FUNDING.yml

@@ -0,0 +1,33 @@
+name: Documentation
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+        fetch-depth: 0
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+          enable-cache: true
+          cache-dependency-glob: uv.lock
+
+    - name: Install the project
+      run: uv sync --extra doc
+  
+    - name: Build documentation
+      run: |
+        make --directory=doc html
+        touch ./doc/build/html/.nojekyll
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./doc/build/html

.github/workflows/doc.yml

@@ -11,18 +11,18 @@ jobs:
     - uses: actions/checkout@v4
       with:
         persist-credentials: false
+        fetch-depth: 0
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+          enable-cache: true
+          cache-dependency-glob: uv.lock
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
-        python-version: "3.x"
-    - name: Install pypa/build
-      run: >-
-        python3 -m
-        pip install
-        build
-        --user
-    - name: Build a binary wheel and a source tarball
-      run: python3 -m build
+        python-version-file: ".python-version"
+    - name: Build
+      run: uv build
     - name: Store the distribution packages
       uses: actions/upload-artifact@v4
       with:
@@ -38,18 +38,22 @@ jobs:
     runs-on: ubuntu-latest
     environment:
       name: pypi
-      url: https://pypi.org/p/pyannote.pipeline
     permissions:
-      id-token: write  # IMPORTANT: mandatory for trusted publishing
-
+      id-token: write
     steps:
     - name: Download all the dists
       uses: actions/download-artifact@v4
       with:
         name: python-package-distributions
         path: dist/
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        enable-cache: true
+        cache-dependency-glob: uv.lock
     - name: Publish distribution 📦 to PyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
+      run: uv publish --trusted-publishing always  --publish-url https://upload.pypi.org/legacy/
+
 
   github-release:
     name: >-
@@ -94,26 +98,28 @@ jobs:
         "$GITHUB_REF_NAME" dist/**
         --repo "$GITHUB_REPOSITORY"
 
-  publish-to-testpypi:
-    name: Publish Python 🐍 distribution 📦 to TestPyPI
-    needs:
-    - build
-    runs-on: ubuntu-latest
-
-    environment:
-      name: testpypi
-      url: https://test.pypi.org/p/pyannote.pipeline
-
-    permissions:
-      id-token: write  # IMPORTANT: mandatory for trusted publishing
-
-    steps:
-    - name: Download all the dists
-      uses: actions/download-artifact@v4
-      with:
-        name: python-package-distributions
-        path: dist/
-    - name: Publish distribution 📦 to TestPyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
-      with:
-        repository-url: https://test.pypi.org/legacy/
+#   publish-to-testpypi:
+#     name: Publish Python 🐍 distribution 📦 to TestPyPI
+#     needs:
+#     - build
+#     runs-on: ubuntu-latest
+#
+#     environment:
+#       name: testpypi
+#
+#     permissions:
+#       id-token: write  # IMPORTANT: mandatory for trusted publishing
+#
+#     steps:
+#     - name: Download all the dists
+#       uses: actions/download-artifact@v4
+#       with:
+#         name: python-package-distributions
+#         path: dist/
+#     - name: Install uv
+#       uses: astral-sh/setup-uv@v5
+#       with:
+#         enable-cache: true
+#         cache-dependency-glob: uv.lock
+#     - name: Publish distribution 📦 to PyPI
+#       run: uv publish --trusted-publishing always  --publish-url https://test.pypi.org/legacy/

.github/workflows/pypi.yml

@@ -2,34 +2,35 @@ name: Test
 
 on:
   pull_request:
-    branches: 
+    branches:
       - develop
   push:
-    branches: 
+    branches:
       - develop
       - master
       - release/*
 
-jobs:
-  build:
 
+jobs:
+  test:
+    name: Test
     runs-on: ubuntu-latest
     strategy:
-      max-parallel: 4
       matrix:
-        python-version: [3.8]
-
+        python-version: 
+          - "3.10"
+          - "3.11"
+          - "3.12"
+    env:
+      UV_PYTHON: ${{ matrix.python-version }}
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install from source
-      run: |
-        python -m pip install --upgrade pip
-        pip install .
-    - name: Test with pytest
-      run: |
-        pip install pytest
-        pytest tests/
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Install the project
+        run: uv sync --extra test
+
+      - name: Run tests
+        run: uv run pytest tests

.github/workflows/publish.yml renamed to .github/workflows/release.yml

@@ -0,0 +1 @@
+3.10

.github/workflows/test.yml

@@ -10,11 +10,11 @@ BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
 help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	uv run --extra doc $(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 .PHONY: help Makefile
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	uv run --extra doc $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.python-version

@@ -2,6 +2,14 @@
 Changelog
 #########
 
+Unreleased
+~~~~~~~~~~
+
+- BREAKING: drop support to `Python` < 3.10
+- BREAKING: switch to native namespace package 
+- BREAKING: remove `pyannote.pipeline.blocks` submodule
+- setup: switch to `uv`
+
 Version 3.1.2 (2025-02-07)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 

MANIFEST.in

@@ -42,8 +42,6 @@
     "sphinx.ext.mathjax",
     "sphinx.ext.viewcode",
     "sphinx.ext.githubpages",
-    "matplotlib.sphinxext.plot_directive",
-    "IPython.sphinxext.ipython_directive",
 ]
 
 
@@ -68,15 +66,15 @@
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = ".rst"
+source_suffix = {".rst": "restructuredtext"}
 
 # The master toctree document.
 master_doc = "index"
 
 # General information about the project.
-project = u"pyannote.pipeline"
-copyright = u"2018, CNRS"
-author = u"Hervé Bredin"
+project = "pyannote.pipeline"
+copyright = "2017, CNRS"
+author = "Hervé Bredin"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -94,7 +92,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -113,10 +111,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-import sphinx_rtd_theme
-
 html_theme = "sphinx_rtd_theme"
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -133,7 +128,7 @@
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "pyannotecoredoc"
+htmlhelp_basename = "pyannotepipelinedoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -160,8 +155,8 @@
     (
         master_doc,
         "pyannotepipeline.tex",
-        u"pyannote.pipeline Documentation",
-        u"Hervé Bredin",
+        "pyannote.pipeline Documentation",
+        "Hervé Bredin",
         "manual",
     ),
 ]
@@ -172,7 +167,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, "pyannotepipeline", u"pyannote.pipeline Documentation", [author], 1)
+    (master_doc, "pyannotepipeline", "pyannote.pipeline Documentation", [author], 1)
 ]
 
 
@@ -185,7 +180,7 @@
     (
         master_doc,
         "pyannotepipeline",
-        u"pyannote.pipeline Documentation",
+        "pyannote.pipeline Documentation",
         author,
         "pyannotepipeline",
         "One line description of project.",
@@ -194,7 +189,8 @@
 ]
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {"https://docs.python.org/": None}
-
-
-ipython_savefig_dir = "../../build/html/_static"
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/", None),
+    "pyannote.core": ("https://pyannote.github.io/pyannote-core", None),
+    "pyannote.database": ("https://pyannote.github.io/pyannote-database", None),
+}