feat!: Rename tket2* libs to tket* (#987)

This affects both rust and python libraries.
Since we are renaming the main packages, I just renamed all the
sub-crates / libs too to keep thing consistent and reduce confusion.

Extension names have **not** been updated, as I worry about further
breakage.
Should we update them (in a separate PR)?

### Project breakage

- For dependents, the breakage should be limited to having to update the
dependency names and some types like `Tk2Op` to `TketOp`,
`TKET2_EXTENSION` to `TKET_EXTENSION`, etc.

- For the local automation, I tried to update the workflows as much as
possible, but we can only test them once merged.
- `release-please`'s manifest has been updated. I'll recreate the last
python release tags without the `2`, and the workflow should pick up
from there. We'll need to swap some pypi API keys before merging the
release PR.
- `release-plz` will probably get confused with which commits should be
picked.
- ~It also does not have permission to publish new crates, so we'll need
to manually push `tket-hseries` and update the API keys.~
- Both the `tket` and `tket-qsystem` crates have been created and setup
for trusted publishing, so the release should work correctly.
  
### Follow up and deprecation.

We'll need to make patch releases for the `tket2*` libraries adding a
deprecation warning to the README and directing users to the new
libraries.

- Por python, take a look at the `pypi-rename` [README
template](https://github.com/simonw/pypi-rename/blob/main/%7B%7Bcookiecutter.old_package_name%7D%7D/README.md).
- For rust, make sure to update both the README and `lib.rs` rusdocs.
- Rustdoc recently added support for warning boxes:
[rust-lang/rust#106561](https://www.github.com/rust-lang/rust/pull/106561)

BREAKING CHANGES: Yes
BREAKING CHANGE: Libraries renamed from `tket2*` to `tket*`

---------

Co-authored-by: Alec Edgington <54802828+cqc-alec@users.noreply.github.com>

Author: 2 people

.github/CODEOWNERS

@@ -1,6 +1,6 @@
 # for syntax see https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#codeowners-syntax
 
-# base rule, tket2 team is codeowner for whole repo
+# base rule, tket team is codeowner for whole repo
 * @CQCL/tket2
 
 # Add specific rules below.

.github/change-filters.yml

@@ -2,24 +2,24 @@
 # to detect changes in each subproject, and only run the corresponding jobs.
 
 rust-core: &rust-core
-  - "tket2/**"
+  - "tket/**"
   - "Cargo.toml"
   - "Cargo.lock"
 
 rust:
   - *rust-core
-  - "tket2-hseries/**"
+  - "tket-qsystem/**"
   - "badger-optimiser/**"
   - "compile-rewriter/**"
   - "tket1-passes/**"
 
 python:
   - *rust-core
-  - "tket2-py/**"
-  - "tket2-eccs/**"
-  - "tket2-exts/**"
+  - "tket-py/**"
+  - "tket-eccs/**"
+  - "tket-exts/**"
   - "pyproject.toml"
   - "uv.lock"
 
 extensions:
-  - "tket2-exts/src/tket2_exts/data/tket2/**"
+  - "tket-exts/src/tket_exts/data/tket/**"

.github/dependabot.yml

@@ -27,9 +27,9 @@ updates:
   - package-ecosystem: "pip"
     directories: # Location of package manifests
       - "/"
-      - "/tket2-py"
-      - "/tket2-eccs"
-      - "/tket2-exts"
+      - "/tket-py"
+      - "/tket-eccs"
+      - "/tket-exts"
     schedule:
       interval: "weekly"
     commit-message:

.github/workflows/ci.yml

@@ -121,7 +121,7 @@ jobs:
       - name: Install cargo-codspeed
         run: cargo binstall cargo-codspeed --force
       - name: Override criterion with the CodSpeed harness
-        run: cargo add --dev codspeed-criterion-compat --rename criterion --package tket2
+        run: cargo add --dev codspeed-criterion-compat --rename criterion --package tket
       - name: Build benchmarks
         run: cargo codspeed build --profile bench --features portmatching,binary-eccs,rewrite-tracing
       - name: Run benchmarks
@@ -146,9 +146,9 @@ jobs:
       - name: Configure default rust toolchain
         run: rustup override set ${{steps.toolchain.outputs.name}}
       - name: Build with no features
-        run: cargo test --verbose -p tket2 -p tket2-py -p tket2-hseries --no-default-features --no-run
+        run: cargo test --verbose -p tket -p tket-py -p tket-qsystem --no-default-features --no-run
       - name: Tests with no features
-        run: cargo test --verbose -p tket2 -p tket2-py -p tket2-hseries --no-default-features
+        run: cargo test --verbose -p tket -p tket-py -p tket-qsystem --no-default-features
 
   # Run tests on Rust stable
   tests-rs-stable-all-features:
@@ -291,7 +291,7 @@ jobs:
           token: ${{ secrets.CODECOV_TOKEN }}
 
   # Ensure that serialized extensions match rust implementation
-  tket2-extensions:
+  tket-extensions:
     needs: [changes, tests-rs-stable-all-features]
     if: ${{ needs.changes.outputs.rust == 'true' && github.event_name != 'merge_group' }}
     name: Check standard extensions
@@ -306,11 +306,11 @@ jobs:
         run: just gen-extensions
       - name: Check if the declarations are up to date
         run: |
-          git diff --exit-code --name-only tket2-exts/src/tket2_exts/data
+          git diff --exit-code --name-only tket-exts/src/tket_exts/data
           if [ $? -ne 0 ]; then
             echo "The serialized standard extensions are not up to date"
             echo "Please run 'just gen-extensions' and commit the changes.
-            Bump the version of tket2-exts according to semver.
+            Bump the version of tket-exts according to semver.
             "
             exit 1
           fi
@@ -348,7 +348,7 @@ jobs:
   # even if they are skipped due to no changes in the relevant files.
   required-checks:
     name: Required checks 🦀+🐍
-    needs: [changes, check-rs, check-py, tests-rs-stable-no-features, tests-rs-stable-all-features, tests-py, tket2-extensions, extension-versions]
+    needs: [changes, check-rs, check-py, tests-rs-stable-no-features, tests-rs-stable-all-features, tests-py, tket-extensions, extension-versions]
     if: ${{ !cancelled() }}
     runs-on: ubuntu-latest
     steps:

.github/workflows/python-pure-wheels.yml

@@ -1,7 +1,7 @@
 name: Pure Python wheels 🐍
 # Builds and publishes the pure wheels on pypi.
 #
-# This does not include the main `tket2-py` package, which is built using maturin.
+# This does not include the main `tket-py` package, which is built using maturin.
 # See `python-wheels.yml` for that workflow.
 #
 # When running on a release event or as a workflow dispatch for a tag,
@@ -33,8 +33,8 @@ jobs:
     strategy:
       matrix:
         target:
-          - { dir: tket2-eccs, name: tket2_eccs}
-          - { dir: tket2-exts, name: tket2_exts}
+          - { dir: tket-eccs, name: tket_eccs}
+          - { dir: tket-exts, name: tket_exts}
     steps:
       # Check the release tag against the package name
       #

.github/workflows/python-wheels.yml

@@ -21,7 +21,7 @@ permissions:
   contents: read
 
 env:
-  MODULE_DIR: tket2-py
+  MODULE_DIR: tket-py
 
 jobs:
   # Check if the tag matches the package name,
@@ -37,7 +37,7 @@ jobs:
         run: |
           echo "run=$SHOULD_RUN" >> $GITHUB_OUTPUT
         env:
-          SHOULD_RUN: ${{ github.event_name != 'release' || ( github.ref_type == 'tag' && startsWith(github.ref, 'refs/tags/tket2-py-v') ) }}
+          SHOULD_RUN: ${{ github.event_name != 'release' || ( github.ref_type == 'tag' && startsWith(github.ref, 'refs/tags/tket-py-v') ) }}
 
   linux:
     needs: check-tag
@@ -192,7 +192,7 @@ jobs:
     name: Release
     runs-on: ubuntu-latest
     needs: [linux, musllinux, windows, macos, sdist]
-    if: ${{ (github.event_name == 'release' && github.ref_type == 'tag' && startsWith(github.ref, 'refs/tags/tket2-py-v') ) || (github.event_name == 'workflow_dispatch' && github.ref_type == 'tag' && startsWith(github.ref, 'refs/tags/tket2-py-v') ) }}
+    if: ${{ (github.event_name == 'release' && github.ref_type == 'tag' && startsWith(github.ref, 'refs/tags/tket-py-v') ) || (github.event_name == 'workflow_dispatch' && github.ref_type == 'tag' && startsWith(github.ref, 'refs/tags/tket-py-v') ) }}
     steps:
       - uses: actions/download-artifact@v4
       - name: Publish to PyPI

.github/workflows/release-checks.yml

@@ -1,13 +1,13 @@
-# A check that ensures that `tket2-py` works correctly with the latest release of `tket2-exts` and `tket2-eccs`.
+# A check that ensures that `tket-py` works correctly with the latest release of `tket-exts` and `tket-eccs`.
 #
-# If this fails, it is likely that the packages require a release before we can release the `tket2` python lib.
+# If this fails, it is likely that the packages require a release before we can release the `tket` python lib.
 
-name: tket2-py Release checks
+name: tket-py Release checks
 
 on:
   pull_request:
     branches:
-      - release-please--branches--main--components--tket2-py
+      - release-please--branches--main--components--tket-py
   workflow_dispatch: {}
 
 env:
@@ -21,7 +21,7 @@ env:
 
 jobs:
   py-release:
-    name: Check `tket2-py` release compatibility
+    name: Check `tket-py` release compatibility
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -37,8 +37,8 @@ jobs:
         run: |
           uv sync --no-sources --no-install-workspace \
             --python ${{ env.PYTHON_HIGHEST }}
-          uv pip install --no-sources tket2-exts
-          uv pip install --no-sources tket2-eccs
+          uv pip install --no-sources tket-exts
+          uv pip install --no-sources tket-eccs
           uv run --no-sync maturin develop
           echo "\nDone! Installed dependencies:"
           uv pip list

.github/workflows/semver-checks.yml

@@ -28,7 +28,7 @@ jobs:
       TKET_C_API_PATH: ${{ github.workspace }}/tket-c-api
       LD_LIBRARY_PATH: ${{ github.workspace }}/tket-c-api/lib
     steps:
-      - name: Checkout tket2
+      - name: Checkout tket
         uses: actions/checkout@v4
       - name: Install tket-c-api library
         uses: ./.github/actions/tket-c-api

.gitignore

@@ -1,6 +1,6 @@
 # Build artifacts
 /target
-tket2-py/target/
+tket-py/target/
 /dist
 
 # Python caches

.pre-commit-config.yaml

@@ -93,7 +93,7 @@ repos:
       - id: py-test
         name: pytest
         description: Run python tests
-        # Ensure that we are using the local version of `tket2-eccs` and not the one from PyPI
+        # Ensure that we are using the local version of `tket-eccs` and not the one from PyPI
         entry: uv run -- sh -c "maturin develop && pytest --cov=./ --cov-report=html"
         language: system
         files: \.py$