Rewrite in Rust (#2)

* Initial setup for Rust code

* Port CICKind to Rust

* Literal port of python code for checksum

* Write tests for calculateChecksum

* Port detect

* Cleanup CICKind

* Wire up function bindings

* yeet python logic

* Add name attribute

* Start fixing CI

* ci for rust

* cargo fmt

* clippy

* changelog and readme

* some docs

* fmt

* fix ci?

.github/workflows/mypy.yml

@@ -18,7 +18,7 @@ jobs:
 
     - name: Install Dependencies
       run: |
-        pip3 install mypy -U
+        pip3 install -U mypy
 
     - name: mypy
       run: mypy --show-column-numbers --hide-error-context .

.github/workflows/publish_crate.yml

@@ -0,0 +1,42 @@
+name: Build and upload Rust crate
+
+# Build on every branch push, tag push, and pull request change:
+on: [push, pull_request]
+
+jobs:
+  build_rust:
+    name: Build Rust stuff and run Rust tests
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout reposistory
+      uses: actions/checkout@v4
+
+    - name: Setup Rust toolchain
+      uses: actions-rs/toolchain@v1
+      with:
+        toolchain: stable
+        override: true
+
+    - name: Check format
+      run: cargo fmt --check
+
+    - name: Setup clippy
+      run: rustup component add clippy
+
+    - name: Run clippy
+      run: cargo clippy --all-targets --all-features -- -D warnings
+
+    - name: Build Rust package
+      run: cargo build --release --workspace
+
+    - name: Build Rust tests
+      run: cargo test --workspace
+
+    - name: Publish dry run
+      if: github.event_name == 'push' && !startsWith(github.ref, 'refs/tags/')
+      run: cargo publish --dry-run
+
+    - name: Upload crate
+      if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+      run: cargo publish --token ${{ secrets.CARGO_REGISTRY_TOKEN }}

.github/workflows/tests.yml

@@ -12,6 +12,10 @@ jobs:
     - name: Checkout repository
       uses: actions/checkout@v4
 
+    - name: Install Dependencies
+      run: |
+        pip3 install -U maturin
+
     - name: Install local ipl3checksum
       run: pip install .
 

.github/workflows/tests_other_repo.yml

@@ -4,8 +4,8 @@ name: Test other repo
 on: [push, pull_request]
 
 jobs:
-  build_repo:
-    name: Test other repo
+  test_other_repo_py:
+    name: Test other repo (Python)
     runs-on: ubuntu-latest
 
     strategy:
@@ -15,6 +15,10 @@ jobs:
     - name: Checkout repository
       uses: actions/checkout@v4
 
+    - name: Install Dependencies
+      run: |
+        python3 -m pip install -U maturin
+
     - name: Install local ipl3checksum
       run: python3 -m pip install .
 

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "rust-analyzer.cargo.features": [
+        "c_bindings",
+        "python_bindings"
+    ]
+}

CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add Rust support
+- New static method `CICKind.fromHashMd5`.
+  - Returns a CIC kind based on the passed md5 hash.
+
+### Changed
+
+- Library was reimplemented in Rust, allowing faster runtime calculation.
+  - The Python API is still the same
+
+### Fixed
+
 - Fix links in `CHANGELOG.md`
 
 ## [1.0.1] - 2023-09-21