chore: move Python Solver to new repo (#1693)

Moving the code to https://github.com/TimefoldAI/timefold-solver-python/

---------

Co-authored-by: Lukáš Petrovický <[email protected]>

Author: Christopher-Chianelli

.github/workflows/codeql.yml

@@ -27,8 +27,6 @@ jobs:
         include:
         - language: java-kotlin
           build-mode: autobuild
-        - language: python
-          build-mode: none
         - language: javascript-typescript # Need to add this even though we don't want this; otherwise Github complains.
           build-mode: none
     steps:

.github/workflows/finish_release.yml

@@ -23,7 +23,6 @@ jobs:
           git config user.email "[email protected]"
           git checkout $RELEASE_BRANCH_NAME
           mvn -Dfull versions:set -DnewVersion=999-SNAPSHOT
-          sed -i "s/^timefold_solver_python_version.*=.*/timefold_solver_python_version = '999-dev0'/" setup.py
           git commit -am "build: move back to 999-SNAPSHOT"
           git push origin $RELEASE_BRANCH_NAME          
 

.github/workflows/pull_request.yml

@@ -103,54 +103,6 @@ jobs:
           cd spring-integration
           mvn -B verify
 
-  python:
-    name: "Python Solver"
-    concurrency:
-      group: pull_request-python-${{ github.event_name }}-${{ github.head_ref }}-${{ matrix.os }}-${{ matrix.java-version }}
-      cancel-in-progress: true
-    runs-on: ${{matrix.os}}
-    strategy:
-      matrix:
-        os: [ ubuntu-latest, macos-latest, windows-latest ]
-        java-version: [ 21 ] # Latest LTS if not Ubuntu
-        include:
-          - os: ubuntu-latest
-            java-version: 17
-          - os: ubuntu-latest
-            java-version: 24
-    timeout-minutes: 120
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-java@v4
-        with:
-          java-version: ${{matrix.java-version}}
-          distribution: 'temurin'
-          cache: 'maven'
-
-      # Need to install all Python versions in the same run for tox
-      - name: Python 3.10, Python 3.11, Python 3.12 Setup
-        uses: actions/setup-python@v5
-        with:
-          python-version: |
-            3.10
-            3.11
-            3.12
-          cache: 'pip'
-          cache-dependency-path: |
-            **/setup.py
-
-      - name: Install tox
-        run:
-          pip install tox build
-
-      - name: Run tox on Timefold Solver for Python test suite
-        run: python -m tox
-
-      - name: Run tox on jpyinterpreter test suite
-        working-directory: ./python/jpyinterpreter
-        run: python -m tox
-
   native:
     name: "Native Image"
     concurrency:

.github/workflows/pull_request_quickstarts.yml

@@ -67,69 +67,4 @@ jobs:
       - name: Build and test timefold-quickstarts
         working-directory: ./timefold-quickstarts
         shell: bash
-        run: mvn -B clean verify
-  python:
-    name: "Python Quickstarts"
-    concurrency:
-      group: pull_request_python_quickstarts-${{ github.event_name }}-${{ github.head_ref }}-${{ matrix.os }}-${{ matrix.java-version }}-${{ matrix.python-version }}
-      cancel-in-progress: true
-    strategy:
-      matrix:
-        os: [ ubuntu-latest ]
-        java-version: [ 21 ] # Only the latest supported LTS; already too many jobs here.
-        # TODO: Add Python 3.10 once employee scheduling and school timetabling support it
-        python-version: ['3.11', '3.12']
-      fail-fast: false
-    runs-on: ${{ matrix.os }}
-
-    steps:
-      - name: Check out repository code
-        uses: actions/checkout@v4
-        with:
-          path: './timefold-solver'
-
-      # Need to check for stale repo, since Github is not aware of the build chain and therefore doesn't automate it.
-      - name: Checkout timefold-quickstarts (PR) # Checkout the PR branch first, if it exists
-        if: github.head_ref # Only true if this is a PR.
-        id: checkout-quickstarts-pr
-        uses: actions/checkout@v4
-        continue-on-error: true
-        with:
-          repository: ${{ github.actor }}/timefold-quickstarts
-          ref: ${{ github.head_ref }}
-          path: ./timefold-quickstarts
-          fetch-depth: 0 # Otherwise merge will fail on account of not having history.
-      - name: Checkout timefold-quickstarts (development) # Checkout the development branch if the PR branch does not exist
-        if: steps.checkout-quickstarts-pr.outcome != 'success'
-        uses: actions/checkout@v4
-        with:
-          repository: TimefoldAI/timefold-quickstarts
-          ref: development
-          path: ./timefold-quickstarts
-          fetch-depth: 0 # Otherwise merge will fail on account of not having history.
-
-      # Build and test
-      - name: "Setup Java and Maven"
-        uses: actions/setup-java@v4
-        with:
-          java-version: ${{matrix.java-version}}
-          distribution: 'temurin'
-          cache: 'maven'
-      - name: Python Setup
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{matrix.python-version}}
-          cache: 'pip'
-          cache-dependency-path: |
-            **/setup.py
-      - name: Install build
-        run:
-          pip install build
-      - name: Build Timefold Solver for Python
-        working-directory: ./timefold-solver
-        run: python -m build
-      - name: Build and test timefold-quickstarts
-        working-directory: ./timefold-quickstarts
-        env:
-          TIMEFOLD_SOLVER_PYTHON_DIST: "${{ github.workspace }}/timefold-solver/dist"
-        run: .github/scripts/run_python_tests.sh
+        run: mvn -B clean verify

.github/workflows/pull_request_secure.yml

@@ -187,77 +187,6 @@ jobs:
         working-directory: ./timefold-solver-enterprise
         shell: bash
         run: mvn -B clean verify
-  enterprise-python:
-    needs: approval_required
-    name: Enterprise Edition (Python)
-    concurrency:
-      group: downstream-enterprise-python-${{ github.event_name }}-${{ github.head_ref }}
-      cancel-in-progress: true
-    timeout-minutes: 120
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out repository code
-        uses: actions/checkout@v4
-        with:
-          path: './timefold-solver'
-          ref: ${{ github.event.pull_request.head.sha }} # The GHA event will pull the main branch by default, and we must specify the PR reference version
-
-      # Clone timefold-solver-enterprise
-      # Need to check for stale repo, since Github is not aware of the build chain and therefore doesn't automate it.
-      - name: Checkout timefold-solver-enterprise (PR) # Checkout the PR branch first, if it exists
-        id: checkout-solver-enterprise
-        uses: actions/checkout@v4
-        continue-on-error: true
-        with:
-          repository: TimefoldAI/timefold-solver-enterprise
-          ref: ${{ github.head_ref }}
-          token: ${{ secrets.JRELEASER_GITHUB_TOKEN }} # Safe; only used to clone the repo and not stored in the fork.
-          path: ./timefold-solver-enterprise
-          fetch-depth: 0 # Otherwise merge will fail on account of not having history.
-
-      - name: Checkout timefold-solver-enterprise (main) # Checkout the main branch if the PR branch does not exist
-        if: steps.checkout-solver-enterprise.outcome != 'success'
-        uses: actions/checkout@v4
-        with:
-          repository: TimefoldAI/timefold-solver-enterprise
-          ref: main
-          token: ${{ secrets.JRELEASER_GITHUB_TOKEN }} # Safe; only used to clone the repo and not stored in the fork.
-          path: ./timefold-solver-enterprise
-          fetch-depth: 0 # Otherwise merge will fail on account of not having history.
-
-      # Build and test
-      - name: Set up the JDK
-        uses: actions/setup-java@v4
-        with:
-          java-version: 17
-          distribution: 'temurin'
-          cache: 'maven'
-
-      # Need to install all Python versions in the same run for tox
-      - name: Python 3.10, Python 3.11, Python 3.12 Setup
-        uses: actions/setup-python@v5
-        with:
-          python-version: |
-            3.10
-            3.11
-            3.12
-          cache: 'pip'
-          cache-dependency-path: |
-            **/setup.py
-
-      - name: Install tox
-        run:
-          pip install tox build
-
-      - name: Build Timefold Solver for Python
-        working-directory: ./timefold-solver
-        run: python -m build
-
-      - name: Run tox on Timefold Solver Enterprise for Python test suite
-        working-directory: ./timefold-solver-enterprise
-        env:
-          PIP_FIND_LINKS: ${{ github.workspace }}/timefold-solver/dist
-        run: tox
 
   build_documentation:
     runs-on: ubuntu-latest
@@ -350,19 +279,6 @@ jobs:
           java-version: 17
           distribution: 'temurin'
           cache: 'maven'
-      - name: Python 3.10, Python 3.11, Python 3.12 Setup
-        uses: actions/setup-python@v5
-        with:
-          python-version: |
-            3.10
-            3.11
-            3.12
-          cache: 'pip'
-          cache-dependency-path: |
-            **/setup.py
-      - name: Install tox
-        run:
-          pip install tox coverage pytest pytest-cov
       - name: Cache SonarCloud packages
         uses: actions/cache@v4
         with:
@@ -372,24 +288,6 @@ jobs:
       - name: Build with Maven to measure code coverage # The ENV variables are limited to the scope of the current step. Avoid adding sensitive ENV variables here as the tests could leak them.
         run: mvn -B clean install -Prun-code-coverage
 
-      - name: Get JaCoCo Agent
-        run: mvn org.apache.maven.plugins:maven-dependency-plugin:3.8.1:copy -Dartifact=org.jacoco:org.jacoco.agent:0.8.13:jar:runtime -DoutputDirectory=target/jacocoagent.jar
-
-      - name: Run tox to measure timefold solver python code coverage from Python tests
-        # Sometimes crashes at the very end when using JaCoCo.
-        # This crash happens after everything is processed and stored, and therefore can be safely ignored.
-        # Ignore the crash to not ruin the long-running build.
-        continue-on-error: true
-        run: python -m tox -- --cov=timefold --cov-report=xml:target/coverage.xml --cov-config=tox.ini --cov-branch --cov-append --jacoco-agent=./target/jacocoagent.jar
-
-      - name: Run tox to measure jpyinterpreter code coverage from Python tests
-        working-directory: ./python/jpyinterpreter
-        # Sometimes crashes at the very end when using JaCoCo.
-        # This crash happens after everything is processed and stored, and therefore can be safely ignored.
-        # Ignore the crash to not ruin the long-running build.
-        continue-on-error: true
-        run: python -m tox -- --cov=jpyinterpreter --cov-report=xml:target/coverage.xml --cov-config=tox.ini --cov-branch --cov-append --jacoco-agent=../../target/jacocoagent.jar --jacoco-output=../../target/jacoco.exec
-
       - name: Run analysis
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any

.github/workflows/release.yml

@@ -16,10 +16,6 @@ on:
       version:
         description: 'Release version (e.g. 1.0.0)'
         required: true
-      pythonVersionSuffix:
-        description: 'What suffix to append to the Python version (ex: b0 for beta release)'
-        required: true
-        default: b0
       sourceBranch:
         description: 'Branch to cut the release from'
         default: main
@@ -34,9 +30,6 @@ jobs:
       MAVEN_ARGS: "--no-transfer-progress --batch-mode"
       RELEASE_BRANCH_NAME: "__timefold_release_branch__"
     runs-on: self-hosted
-    environment:
-      name: pypi
-      url: https://pypi.org/p/timefold
     permissions:
       contents: write  # IMPORTANT: required for action to create release branch
       pull-requests: write # IMPORTANT: so release PR can be created
@@ -70,25 +63,13 @@ jobs:
         with:
           maven-version: 3.9.3
 
-      - name: Python 3.12 Setup
-        uses: actions/setup-python@v5
-        with:
-          python-version: 3.12
-
-      - name: Install Pip and build
-        run: |
-          python -m pip install --upgrade pip
-          pip install build          
-
       # We skip tests in dry run, to make the process faster.
       # Technically, this goes against the main reason for doing a dry run; to eliminate potential problems.
       # But unless something catastrophic happened, PR checks on source branch already ensured that all tests pass.
       - name: Set release version and build release
         run: |
           mvn -Dfull versions:set -DnewVersion=${{ github.event.inputs.version }}
-          sed -i "s/^timefold_solver_python_version.*=.*/timefold_solver_python_version = '${{ github.event.inputs.version }}${{ github.event.inputs.pythonVersionSuffix }}'/" setup.py
           mvn -Dfull deploy -DskipTests=${{ github.event.inputs.dryRun }} -DaltDeploymentRepository=local::default::file://`pwd`/target/staging-deploy
-          python -m build
           cp docs/target/antora-template.yml docs/src/antora.yml
           git add docs/src/antora.yml
           find . -name 'pom.xml' | xargs git add
@@ -115,7 +96,3 @@ jobs:
           path: |
             out/jreleaser/trace.log
             out/jreleaser/output.properties
-
-      - name: Publish distribution to PyPI
-        uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # release/v1
-        if: ${{ github.event.inputs.dryRun == 'false' }}

.gitignore

@@ -1,11 +1,5 @@
 target
 local
-__pycache__
-/*.egg-info
-/dist
-/python/**/dist
-/python/**/*.egg-info
-/python/**/*-stubs
 
 # Eclipse, Netbeans and IntelliJ files
 /.*

CONTRIBUTING.adoc

@@ -28,14 +28,6 @@ Use one of the following ways to build this project:
 
 * :mechanical_arm: *build-all*: `mvn clean install -Dfull` runs all checks and creates documentation and distribution files (~20 min)
 
-=== Build the Timefold Solver Python package
-
-* :hammer: *build-fast*: `python -m build` skips any checks and code analysis (~1 min)
-
-* :mechanical_arm: *build-test*: `tox -e pyVERSION` (for example, `tox -e py310`) runs tests against a given Python versions (~3 min)
-
-* :mechanical_arm: *build-all*: `tox` runs tests against all supported Python versions (~10 min)
-
 
 === Set up your development environment
 

MANIFEST.in

@@ -17,8 +17,7 @@ image:https://img.shields.io/github/issues/TimefoldAI/timefold-solver?style=for-
 {sonarBadge}&metric=sqale_rating["Maintainability Rating", {sonarLink}]
 {sonarBadge}&metric=coverage["Coverage", {sonarLink}]
 
-Timefold Solver is an AI constraint solver for Java,
-https://github.com/TimefoldAI/timefold-solver/tree/main/python#readme[Python] and Kotlin.
+Timefold Solver is an AI constraint solver for Java and Kotlin.
 You can use Timefold Solver to optimize the Vehicle Routing Problem, Employee Rostering,
 Maintenance Scheduling, Task Assignment, School Timetabling, Cloud Optimization,
 Conference Scheduling, Job Shop Scheduling and many more planning problems.