Merge pull request #8 from Decompollaborate/develop

1.2.1

.github/workflows/maturin_upload_pypi.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: '3.13'
 
       - name: Build wheels
         uses: PyO3/maturin-action@v1
@@ -57,7 +57,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: '3.13'
           architecture: ${{ matrix.target }}
 
       - name: Build wheels
@@ -86,7 +86,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: '3.13'
 
       - name: Build wheels
         uses: PyO3/maturin-action@v1

.github/workflows/mypy.yml

@@ -8,17 +8,23 @@ jobs:
     runs-on: ubuntu-latest
     name: mypy
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
-    - name: Set up Python 3.7
-      uses: actions/setup-python@v4
-      with:
-        python-version: 3.7
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
 
-    - name: Install Dependencies
-      run: |
-        pip3 install -U mypy
+      - name: Setup venv
+        run: |
+          python3 -m venv .venv
+          . .venv/bin/activate
 
-    - name: mypy
-      run: mypy --show-column-numbers --hide-error-context .
+      - name: Install dependencies
+        run: |
+          python3 -m pip install -U mypy
+
+      - name: mypy
+        run: |
+          python3 -m mypy --show-column-numbers --hide-error-context .

.github/workflows/publish_crate.yml

@@ -58,6 +58,20 @@ jobs:
     - name: Run tests
       run: cargo test --workspace
 
+  msrv:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout reposistory
+        uses: actions/checkout@v4
+
+      - name: Setup MSRV checker
+        uses: taiki-e/install-action@cargo-hack
+
+      # To find current MSRV use `cargo msrv find`. Install it with `cargo install cargo-msrv --locked`
+      - name: Run MSRV checker
+        run: cargo hack check --rust-version --workspace --all-targets --ignore-private
+
+
   publish:
     name: Publish
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.1] - 2024-12-15
+
+### Added
+
+- Prebuilt binaries for Python 3.13.
+
+### Changed
+
+- Set MSRV (minimum supported Rust version) to 1.60.
+- Python 3.9 or later is now required.
+  - Bump from Python 3.7 to 3.9.
+  - Older versions can't be checked on CI anymore, so I prefer to not claim to
+    support something that may have broken without anybody noticing.
+  - Nothing really changed. Just the CI tools I was using are refusing to use
+    any Python version older than this. Sorry if you were affected by this.
+
+### Fixed
+
+- Fix some typos
+
 ## [1.2.0] - 2024-01-11
 
 ### Added
@@ -78,6 +98,7 @@ version of the library.
 - Initial relase
 
 [unreleased]: https://github.com/Decompollaborate/ipl3checksum/compare/main...develop
+[1.2.1]: https://github.com/Decompollaborate/ipl3checksum/compare/1.2.0...1.2.1
 [1.2.0]: https://github.com/Decompollaborate/ipl3checksum/compare/1.1.1...1.2.0
 [1.1.1]: https://github.com/Decompollaborate/ipl3checksum/compare/1.1.0...1.1.1
 [1.1.0]: https://github.com/Decompollaborate/ipl3checksum/compare/1.0.1...1.1.0

Cargo.toml

@@ -4,11 +4,12 @@
 [package]
 name = "ipl3checksum"
 # Version should be synced with src/ipl3checksum/__init__.py, pyproject.toml and src/rs/version.rs
-version = "1.2.0"
+version = "1.2.1"
 edition = "2021"
 description = "Library to calculate the IPL3 checksum for N64 ROMs"
 repository = "https://github.com/decompollaborate/ipl3checksum"
 license = "MIT"
+rust-version = "1.60.0"
 
 [lib]
 name = "ipl3checksum"

README.md

@@ -79,8 +79,8 @@ If you use a `requirements.txt` file in your repository, then you can add
 this library with the following line:
 
 ```txt
-ipl3checksum>=1.1.0,<2.0.0
-``````
+ipl3checksum>=1.2.1,<2.0.0
+```
 
 Now you can invoke the library from your script.
 
@@ -124,7 +124,7 @@ cargo add ipl3checksum
 Or add the following line manually to your `Cargo.toml` file:
 
 ```toml
-ipl3checksum = "1.1.0"
+ipl3checksum = "1.2.1"
 ```
 
 ### C bindings

mypy.ini

@@ -1,3 +1,3 @@
 [mypy]
-python_version = 3.7
+python_version = 3.9
 check_untyped_defs = True

pyproject.toml

@@ -4,10 +4,10 @@
 [project]
 name = "ipl3checksum"
 # Version should be synced with src/ipl3checksum/__init__.py, Cargo.toml and src/rs/version.rs
-version = "1.2.0"
+version = "1.2.1"
 description = "Library to calculate the IPL3 checksum for N64 ROMs"
 readme = "README.md"
-requires-python = ">=3.7"
+requires-python = ">=3.9"
 license = {file = "LICENSE"}
 keywords = ["IPL3", "CIC", "checksum", "N64", "Nintendo 64"]
 authors = [

src/ipl3checksum/__init__.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 # Version should be synced with pyproject.toml, Cargo.toml and src/rs/version.rs
-__version_info__: tuple[int, int, int] = (1, 2, 0)
+__version_info__: tuple[int, int, int] = (1, 2, 1)
 __version__ = ".".join(map(str, __version_info__))
 __author__ = "Decompollaborate"
 

src/ipl3checksum/frontends/sum.py

@@ -58,12 +58,12 @@ def processArguments(args: argparse.Namespace):
     exit(doSum(romBytes, kindName, update, outputPath))
 
 def addSubparser(subparser: argparse._SubParsersAction[argparse.ArgumentParser]):
-    parser = subparser.add_parser("sum", help="Calculates the ipl3 checksum of a big endian ROM by detecting the CIC it uses.")
+    parser = subparser.add_parser("sum", help="Calculates the ipl3 checksum of a big endian ROM by detecting the CIC it uses and optionally update it.")
 
     parser.add_argument("rom_path", help="Path to a big endian ROM file", type=Path)
 
-    parser.add_argument("-k", "-c", "--kind", "--cic", help="Used this variant to calculate the checksum instead of automatically detecting which kind the ROM uses", dest="kind", metavar="KIND", choices=ipl3checksum.CICKind.validNames())
-    parser.add_argument("-u", "--update", help="Updates the ROM with the calculated checksum. This option modified the input rom unless `--output` is used", action="store_true")
+    parser.add_argument("-k", "-c", "--kind", "--cic", help="Use this variant to calculate the checksum instead of automatically detecting which kind the ROM uses", dest="kind", metavar="KIND", choices=ipl3checksum.CICKind.validNames())
+    parser.add_argument("-u", "--update", help="Updates the ROM with the calculated checksum. This option modifies the input rom unless `--output` is used", action="store_true")
     parser.add_argument("-o", "--output", help="Path to write the updated ROM. This option is ignored if `--update` is not used", type=Path)
 
     parser.set_defaults(func=processArguments)

src/rs/checksum.rs

@@ -186,7 +186,7 @@ mod tests {
 
                 println!("    Reading...");
 
-                let bin_bytes = fs::read(&bin_path.path()).unwrap();
+                let bin_bytes = fs::read(bin_path.path()).unwrap();
 
                 println!("    Calculating checksum...");
                 let checksum = super::calculate_checksum(&bin_bytes, kind).unwrap();

src/rs/version.rs

@@ -4,12 +4,12 @@
 // Version should be synced with pyproject.toml, Cargo.toml and src/ipl3checksum/__init__.py
 pub static VERSION_MAJOR: i32 = 1;
 pub static VERSION_MINOR: i32 = 2;
-pub static VERSION_PATCH: i32 = 0;
+pub static VERSION_PATCH: i32 = 1;
 
 pub static VERSION_INFO: (i32, i32, i32) = (VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH);
 
 // TODO: figure out a way to construct this string by using VERSION_MAJOR, VERSION_MINOR and VERSION_PATCH (concat! and stringify! didn't work)
-pub static VERSION_STR: &str = "1.2.0";
+pub static VERSION_STR: &str = "1.2.1";
 
 pub static AUTHOR: &str = "Decompollaborate";
 
@@ -24,7 +24,7 @@ mod c_bindings {
 
     // TODO: construct this from super::VERSION_STR
     #[no_mangle]
-    static ipl3checksum_version_str: &[u8] = b"1.2.0\0";
+    static ipl3checksum_version_str: &[u8] = b"1.2.1\0";
 
     // TODO: construct this from super::AUTHOR
     #[no_mangle]