Migration to pyproject.toml

.github/workflows/pythonbuild.yml

@@ -28,20 +28,15 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+      - name: Set up the latest version of uv
+        uses: astral-sh/setup-uv@v5
         with:
-          python-version: ${{ matrix.python-version }}
-      - name: Cache pip
-        uses: actions/cache@v4
-        with:
-          # This path is specific to Ubuntu
-          path: ~/.cache/pip
-          # Look to see if there is a cache hit for the corresponding requirements files
-          key: ${{ format('{0}-pip-{1}', runner.os, hashFiles('dev-requirements.txt', format('requirements{0}.txt', matrix.spark-version-suffix))) }}
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip 'tox<4.0'
+          uv tool install --python-preference only-managed --python 3.12 tox --with tox-uv # we need latest uv, tox, and tox-uv
+          uv python install --python-preference only-managed ${{ matrix.python-version }}
       - name: Setup MySQL DB
         run: |
           sudo /etc/init.d/mysql start
@@ -51,7 +46,7 @@ jobs:
       - name: Build
         env:
           TOXENV: ${{ matrix.tox-env }}
-        run: tox
+        run: uvx --with tox-uv tox run
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v5
         with:
@@ -94,27 +89,23 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Cache pip
-        uses: actions/cache@v4
+      - name: Set up the latest version of uv
+        uses: astral-sh/setup-uv@v5
         with:
-          # This path is specific to Ubuntu
-          path: ~/.cache/pip
-          # Look to see if there is a cache hit for the corresponding requirements files
-          key: ${{ format('{0}-pip-{1}', runner.os, hashFiles('dev-requirements.txt', format('requirements{0}.txt', matrix.spark-version-suffix))) }}
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip 'tox<4.0'
+          uv tool install --python-preference only-managed --python 3.12 tox --with tox-uv # we need latest uv, tox, and tox-uv
+          uv python install --python-preference only-managed ${{ matrix.python-version }}
+
       - name: Create PSQL database
         run: |
           PGPASSWORD=postgres psql -h localhost -p 5432 -c 'create database spotify;' -U postgres
       - name: Build
         env:
           TOXENV: ${{ matrix.tox-env }}
-        run: tox
+        run: uvx --with tox-uv tox run
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v5
         with:
@@ -189,33 +180,54 @@ jobs:
           - python-version: "3.12"
             tox-env: py312-azureblob
 
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up the latest version of uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+      - name: Install dependencies
+        run: |
+          uv tool install --python-preference only-managed --python 3.12 tox --with tox-uv # we need latest uv, tox, and tox-uv
+          uv python install --python-preference only-managed ${{ matrix.python-version }}
+      - name: Build
+        env:
+          TOXENV: ${{ matrix.tox-env }}
+          OVERRIDE_SKIP_CI_TESTS: ${{ matrix.OVERRIDE_SKIP_CI_TESTS }}
+        run: uvx --with tox-uv tox run
+      - name: Upload coverage to Codecov
+        if: ${{ matrix.tox-env != 'flake8' && matrix.tox-env != 'docs' }}
+        uses: codecov/codecov-action@v5
+        with:
+          fail_ci_if_error: true
+          verbose: true
+  others:
+    runs-on: ubuntu-20.04
 
+    strategy:
+      matrix:
+        include:
           - python-version: "3.10"
             tox-env: flake8
           - python-version: "3.10"
             tox-env: docs
-
     steps:
       - uses: actions/checkout@v4
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Cache pip
-        uses: actions/cache@v4
+      - name: Set up the latest version of uv
+        uses: astral-sh/setup-uv@v5
         with:
-          # This path is specific to Ubuntu
-          path: ~/.cache/pip
-          # Look to see if there is a cache hit for the corresponding requirements files
-          key: ${{ format('{0}-pip-{1}', runner.os, hashFiles('dev-requirements.txt', format('requirements{0}.txt', matrix.spark-version-suffix))) }}
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip 'tox<4.0'
+          uv tool install --python-preference only-managed --python 3.12 tox --with tox-uv # we need latest uv, tox, and tox-uv
+          uv python install --python-preference only-managed ${{ matrix.python-version }}
       - name: Build
         env:
           TOXENV: ${{ matrix.tox-env }}
           OVERRIDE_SKIP_CI_TESTS: ${{ matrix.OVERRIDE_SKIP_CI_TESTS }}
-        run: tox
+        run: uvx --with tox-uv tox run
       - name: Upload coverage to Codecov
         if: ${{ matrix.tox-env != 'flake8' && matrix.tox-env != 'docs' }}
         uses: codecov/codecov-action@v5

.gitignore

@@ -172,3 +172,5 @@ Icon
 Network Trash Folder
 Temporary Items
 .apdisk
+
+.python-version

.readthedocs.yaml

@@ -16,3 +16,5 @@ python:
   install:
     - method: pip
       path: .
+      extra_requirements:
+        - readthedocs

CONTRIBUTING.rst

@@ -13,27 +13,29 @@ We are always happy to receive Pull Requests. When you open a PR, it will
 automatically build on Travis. So you're not strictly required to test the
 patch locally before submitting it.
 
-If you do want to run the tests locally you'll need to ``pip install tox`` and
-then run one of the tox commands below.
+If you do want to run the tests locally you'll need to run the commands below
+.. code:: bash
+   pipx install uv
+   uv tool install tox --with tox-uv
 
-You will need a ``tox --version`` of at least 2.0.
+You will need a ``tox --version`` of at least 4.22.
 
 .. code:: bash
 
     # These commands are pretty fast and will tell if you've
     # broken something major:
-    tox -e flake8
-    tox -e py37-core
+    tox run -e flake8
+    tox run -e py37-core
 
     # You can also test particular files for even faster iterations
-    tox -e py37-core test/rpc_test.py
+    tox run -e py37-core -- test/rpc_test.py
 
     # The visualiser tests require phantomjs to be installed on your path
-    tox -e visualiser
+    tox run -e visualiser
 
     # And some of the others involve downloading and running Hadoop:
-    tox -e py33-cdh
-    tox -e py34-hdp
+    tox run -e py38-cdh
+    tox run -e py39-hdp
 
 Where ``flake8`` is the lint checking, ``py37`` is obviously Python 3.7.
 ``core`` are tests that do not require external components and ``cdh`` and
@@ -45,7 +47,7 @@ For `cdh` and `hdp`, tox will download the hadoop distribution for you. You
 however have to have Java installed and the `JAVA_HOME` environment variable
 set.
 
-For more details, check out the ``.travis.yml`` and ``tox.ini`` files.
+For more details, check out the ``.github/workflows/pythonbuild.yml`` and ``tox.ini`` files.
 
 Writing documentation
 =====================
@@ -59,7 +61,7 @@ You verify that your documentation code compiles by running
 
 .. code:: bash
 
-    tox -e docs
+    tox run -e docs
 
 After that, you can check how it renders locally with your browser
 

RELEASE-PROCESS.rst

@@ -2,7 +2,7 @@ For maintainers of Luigi, who have push access to pypi. Here's how you upload
 Luigi to pypi.
 
 #. Make sure [twine](https://pypi.org/project/twine/) is installed ``pip install twine``.
-#. Update version number in `luigi/__meta__.py`.
+#. Update version number in `luigi/__version__.py`.
 #. Commit, perhaps simply with a commit message like ``Version x.y.z``.
 #. Push to GitHub at [spotify/luigi](https://github.com/spotify/luigi).
 #. Clean up previous distributions by executing ``rm -rf dist``

doc/conf.py

@@ -67,7 +67,10 @@ def _warn_node(self, msg, node, *args, **kwargs):
 
 sphinx.environment.BuildEnvironment.warn_node = _warn_node
 
-if os.environ.get('READTHEDOCS', None) == 'True':
+# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+if on_rtd:
     # Run sphinx-apidoc automatically in readthedocs
     # Taken from this: https://lists.torproject.org/pipermail/tor-commits/2012-September/046695.html
     os.system('sphinx-apidoc -o api -T ../luigi --separate')
@@ -83,7 +86,7 @@ def _warn_node(self, msg, node, *args, **kwargs):
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = '1.4.4'  # Value mirrored in doc/conf.py
+needs_sphinx = '1.4.4'  # Value mirrored in pyproject.toml
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -167,9 +170,6 @@ def _warn_node(self, msg, node, *args, **kwargs):
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 
-# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
-
 if not on_rtd:  # only import and set the theme if we're building docs locally
     try:
         import sphinx_rtd_theme

luigi/__init__.py

@@ -18,7 +18,7 @@
 Package containing core luigi functionality.
 """
 
-from luigi.__meta__ import __version__
+from luigi.__version__ import VERSION
 
 from luigi import task
 from luigi.task import (
@@ -56,6 +56,7 @@
 from luigi.event import Event
 
 
+__version__ = VERSION
 __all__ = [
     'task', 'Task', 'Config', 'ExternalTask', 'WrapperTask', 'namespace', 'auto_namespace',
     'DynamicRequirements',

luigi/__version__.py

@@ -0,0 +1,3 @@
+# coding: utf-8
+
+VERSION = '3.6.0'