Merge pull request #44 from bamler-lab/issue-41

(branch name is misleading, it should have been called issue-43)

.github/workflows/release.yaml

@@ -226,7 +226,8 @@ jobs:
 
       - name: generate license file
         run: |
-          cargo install cargo-about
+          cargo install cargo-quickinstall
+          cargo quickinstall cargo-about
           cargo about generate --features=pybindings about.hbs > website/license.html
           wc -l website/license.html
 
@@ -322,6 +323,16 @@ jobs:
         with:
           python-version: "3.12"
 
+      - name: generate license file
+        shell: bash
+        run: |
+          rm LICENSE.*
+          cargo install cargo-quickinstall
+          cargo quickinstall cargo-about
+          cargo about generate --features=pybindings about.hbs > LICENSE.html
+          ls -l LICENSE*
+          wc -l LICENSE*
+
       - name: Build wheels (unix)
         if: matrix.os != 'windows-latest'
         uses: messense/maturin-action@v1
@@ -337,12 +348,6 @@ jobs:
           command: build
           args: --release --strip --features pybindings -i C:\hostedtoolcache\windows\Python\${{ steps.setup-python-3-7.outputs.python-version }}\x64\python3.exe C:\hostedtoolcache\windows\Python\${{ steps.setup-python-3-8.outputs.python-version }}\x64\python3.exe C:\hostedtoolcache\windows\Python\${{ steps.setup-python-3-9.outputs.python-version }}\x64\python3.exe C:\hostedtoolcache\windows\Python\${{ steps.setup-python-3-10.outputs.python-version }}\x64\python3.exe C:\hostedtoolcache\windows\Python\${{ steps.setup-python-3-11.outputs.python-version }}\x64\python3.exe C:\hostedtoolcache\windows\Python\${{ steps.setup-python-3-12.outputs.python-version }}\x64\python3.exe
 
-      # For some reason, manylinux builds create wheels owned by the root user,
-      # which breaks our attempts to add the license file below.
-      - name: Fix wheel ownership on linux
-        if: matrix.os == 'ubuntu-latest'
-        run: sudo chown -R runner:docker target
-
       - name: Cross-build wheels for Apple Silicon
         if: matrix.os == 'macos-latest'
         uses: messense/maturin-action@v1
@@ -366,32 +371,6 @@ jobs:
         if: matrix.os == 'windows-latest'
         run: dir target\wheels\
 
-      - name: generate license file
-        run: |
-          cargo install cargo-about
-          cargo about generate --features=pybindings about.hbs > LICENSE.html
-          ls -l LICENSE.html
-          wc -l LICENSE.html
-
-      - name: Add LICENSE.html to all wheels (unix)
-        if: matrix.os != 'windows-latest'
-        run: |
-          for wheel in target/wheels/*.whl; do
-            zip -ur $wheel LICENSE.html
-          done
-
-      - name: Add LICENSE.html to all wheels (windows)
-        if: matrix.os == 'windows-latest'
-        run: |
-          [Reflection.Assembly]::LoadWithPartialName('System.IO.Compression.FileSystem') | Out-Null
-          Get-ChildItem "target\wheels\" -Filter *.whl |
-          Foreach-Object {
-            $zip = [System.IO.Compression.ZipFile]::Open($_.FullName, "Update")
-            $licenseFile = [System.IO.Path]::GetFileName("LICENSE.html")
-            [System.IO.Compression.ZipFileExtensions]::CreateEntryFromFile($zip, "LICENSE.html", $licenseFile, "Optimal") | Out-Null
-            $zip.Dispose()
-          }
-
       - name: Save artifact with wheels for ${{ matrix.os }}
         uses: actions/upload-artifact@v2
         with:

Cargo.toml

@@ -10,7 +10,7 @@ license = "MIT OR Apache-2.0 OR BSL-1.0"
 name = "constriction"
 readme = "README-rust.md"
 repository = "https://github.com/bamler-lab/constriction/"
-version = "0.3.4"
+version = "0.3.5"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

README-python.md

@@ -29,7 +29,7 @@ into a web app by using `constriction` in a WebAssembly module).
 ### Installing `constriction` for Python
 
 ```bash
-pip install constriction~=0.3.4
+pip install constriction~=0.3.5
 ```
 
 ### Hello, World

README-rust.md

@@ -30,7 +30,7 @@ Add the following to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-constriction = "0.3.4"
+constriction = "0.3.5"
 probability = "0.20.3" # Not strictly required but used in many examples.
 ```
 

README.md

@@ -68,7 +68,7 @@ unnecessarily limit what you can achieve with `constriction`.
 Install `constriction` for Python:
 
 ```bash
-pip install constriction~=0.3.4
+pip install constriction~=0.3.5
 ```
 
 Then go ahead and encode and decode some data:
@@ -105,7 +105,7 @@ Add this line to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-constriction = "0.3.4"
+constriction = "0.3.5"
 probability = "0.17" # Not strictly required but used in many code examples.
 ```
 
@@ -114,7 +114,7 @@ features (and you can't use the `probability` crate):
 
 ```toml
 [dependencies]
-constriction = {version = "0.3.4", default-features = false} # for `no_std` mode
+constriction = {version = "0.3.5", default-features = false} # for `no_std` mode
 ```
 
 Then go ahead and encode and decode some data:

examples/python/01-hello-world.ipynb

@@ -30,7 +30,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "%pip install --upgrade constriction~=0.3.4  # (this will automatically also install numpy)"
+    "%pip install --upgrade constriction~=0.3.5  # (this will automatically also install numpy)"
    ]
   },
   {

examples/python/02-custom-entropy-models.ipynb

@@ -30,7 +30,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "%pip install constriction~=0.3.4 scipy  # (this will automatically also install numpy)"
+    "%pip install constriction~=0.3.5 scipy  # (this will automatically also install numpy)"
    ]
   },
   {