Skip to content

Commit bd40931

Browse files
committed
0.0.9
bumped deps dropped ordered-float Added codeql and cargo deny in CI
1 parent a0f8ee2 commit bd40931

10 files changed

Lines changed: 317 additions & 19 deletions

File tree

.cargo/config.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
test-all = "test --all --features=clang-runtime"
33
clippy-all = "clippy --all --all-targets --features=clang-runtime"
44
fmt-all = "fmt --all"
5+
doc-all = "rustdoc"

.github/workflows/codeql.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: "CodeQL"
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
schedule:
9+
- cron: '0 4 * * 1' # Weekly code scanning
10+
11+
jobs:
12+
analyze:
13+
name: Analyze code (Python & Rust)
14+
runs-on: ubuntu-latest
15+
16+
permissions:
17+
actions: read
18+
contents: read
19+
security-events: write
20+
21+
strategy:
22+
fail-fast: false
23+
matrix:
24+
language: [ rust ]
25+
26+
steps:
27+
- name: Checkout code
28+
uses: actions/checkout@v4
29+
30+
# Set up Rust for FFI library
31+
- name: Set up Rust
32+
uses: dtolnay/rust-toolchain@stable
33+
with:
34+
toolchain: stable
35+
components: clippy
36+
37+
# Initialize CodeQL
38+
- name: Initialize CodeQL
39+
uses: github/codeql-action/init@v3
40+
with:
41+
languages: ${{ matrix.language }}
42+
43+
# Autobuild attempts to build your code (Python & Rust)
44+
- name: Autobuild
45+
uses: github/codeql-action/autobuild@v3
46+
47+
# Run CodeQL analysis
48+
- name: Perform CodeQL Analysis
49+
uses: github/codeql-action/analyze@v3

.github/workflows/rust.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ jobs:
4343
- name: Clone OpenCV repositories
4444
run: |
4545
set -e # Exit immediately on error
46-
OPENCV_VERSION=4.11.0
46+
OPENCV_VERSION=4.12.0
4747
git clone --depth 1 --branch $OPENCV_VERSION https://github.com/opencv/opencv.git
4848
git clone --depth 1 --branch $OPENCV_VERSION https://github.com/opencv/opencv_contrib.git
4949
mkdir -p opencv/build
@@ -61,7 +61,7 @@ jobs:
6161
path: |
6262
opencv/build
6363
${{ github.workspace }}/opencv_install
64-
key: opencv-${{ runner.os }}-${{ hashFiles('opencv/CMakeLists.txt') }}-4.11.0
64+
key: opencv-${{ runner.os }}-${{ hashFiles('opencv/CMakeLists.txt') }}-4.12.0
6565

6666
# Build OpenCV if cache miss
6767
- name: Build OpenCV from source
@@ -90,6 +90,12 @@ jobs:
9090
# Add LD_LIBRARY_PATH for runtime linking
9191
echo "LD_LIBRARY_PATH=${{ github.workspace }}/opencv_install/lib:$LD_LIBRARY_PATH" >> $GITHUB_ENV
9292
93+
- name: Install cargo-deny
94+
run: cargo install cargo-deny
95+
96+
- name: Run cargo-deny
97+
run: cargo deny check
98+
9399
- name: Clippy
94100
run: cargo clippy --all --all-targets --features "clang-runtime"
95101

Cargo.toml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@
22
authors = ["eadf <lacklustr@protonmail.com>"]
33
name = "libstacker"
44
license = "MIT OR Apache-2.0"
5-
version = "0.0.8"
5+
version = "0.0.9"
66
edition = "2024"
77
readme = "README.md"
88
keywords = ["opencv", "image_stacking"]
99
repository = "https://github.com/eadf/libstacker.rs"
1010
description = "Image alignment and stacking functions based on OpenCV and Rayon"
11-
rust-version = "1.85.1"
11+
rust-version = "1.87.0"
1212

1313
[[example]]
1414
name = "main"
1515
path = "examples/main.rs"
16+
doc = false
1617

1718
[dependencies]
18-
opencv = { version = "0.94.3" , features = ["features2d"] }
19-
thiserror = "2.0.12"
20-
ordered-float = "5.0.0"
21-
rayon = "1.10.0"
19+
opencv = { version = "0.97.2", features = ["features2d"] }
20+
thiserror = "2.0.17"
21+
rayon = "1.11.0"
2222

2323
[features]
2424
default = ["clang-runtime"]

LICENSE-MIT

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
Copyright (c) 2021 Eadf <lacklustr@protonmail.com>
2-
This code is ported from code by Mathias Sundholm Copyright (c) 2021 <https://github.com/maitek/image_stacking>
1+
Copyright (c) 2021, 2025 lacklustr@protonmail.com https://github.com/eadf
32

43
Permission is hereby granted, free of charge, to any
54
person obtaining a copy of this software and associated

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
[![Documentation](https://docs.rs/libstacker/badge.svg)](https://docs.rs/libstacker)
33
[![Rust test](https://github.com/eadf/libstacker.rs/actions/workflows/rust.yml/badge.svg?branch=main)](https://github.com/eadf/libstacker.rs/actions/workflows/rust.yml)
44
[![dependency status](https://deps.rs/crate/libstacker/0.0.8/status.svg)](https://deps.rs/crate/libstacker/0.0.8)
5-
![license](https://img.shields.io/crates/l/libstacker)
5+
[![license](https://img.shields.io/crates/l/libstacker?maxAge=2592000)](https://github.com/eadf/libstacker.rs#license)
6+
[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/eadf)
67

78
# libstacker
89
A multithreaded port of the python code found [here: github.com/maitek/image_stacking](https://github.com/maitek/image_stacking)
@@ -20,7 +21,7 @@ Read more about image alignment with OpenCV [here](https://learnopencv.com/image
2021
Opencv-rust can be little tricky to install. Follow the instructions from [rust opencv](https://crates.io/crates/opencv)
2122

2223
You will need the "clang-runtime" feature if you <a href="https://github.com/twistedfall/opencv-rust#Troubleshooting">experience problems with your clang environment</a>
23-
Disclaimer: the library is only built and tested against opencv 4.11.0.
24+
Disclaimer: the library is only built and tested against opencv 4.12.0.
2425

2526
```bash
2627
cargo build --release
@@ -91,3 +92,9 @@ Licensed under either of
9192
* MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT)>
9293

9394
at your option.
95+
96+
## Contribution
97+
98+
Unless explicitly stated otherwise, any contribution intentionally submitted
99+
for inclusion in the project by you, as defined in the Apache-2.0 license,
100+
shall be dual-licensed as above, without any additional terms or conditions.

deny.toml

Lines changed: 236 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,236 @@
1+
# This template contains all of the possible sections and their default values
2+
3+
# Note that all fields that take a lint level have these possible values:
4+
# * deny - An error will be produced and the check will fail
5+
# * warn - A warning will be produced, but the check will not fail
6+
# * allow - No warning or error will be produced, though in some cases a note
7+
# will be
8+
9+
# The values provided in this template are the default values that will be used
10+
# when any section or field is not specified in your own configuration
11+
12+
# Root options
13+
14+
# The graph table configures how the dependency graph is constructed and thus
15+
# which crates the checks are performed against
16+
[graph]
17+
# If 1 or more target triples (and optionally, target_features) are specified,
18+
# only the specified targets will be checked when running `cargo deny check`.
19+
# This means, if a particular package is only ever used as a target specific
20+
# dependency, such as, for example, the `nix` crate only being used via the
21+
# `target_family = "unix"` configuration, that only having windows targets in
22+
# this list would mean the nix crate, as well as any of its exclusive
23+
# dependencies not shared by any other crates, would be ignored, as the target
24+
# list here is effectively saying which targets you are building for.
25+
targets = [
26+
# The triple can be any string, but only the target triples built in to
27+
# rustc (as of 1.40) can be checked against actual config expressions
28+
#"x86_64-unknown-linux-musl",
29+
# You can also specify which target_features you promise are enabled for a
30+
# particular target. target_features are currently not validated against
31+
# the actual valid features supported by the target architecture.
32+
#{ triple = "wasm32-unknown-unknown", features = ["atomics"] },
33+
]
34+
# When creating the dependency graph used as the source of truth when checks are
35+
# executed, this field can be used to prune crates from the graph, removing them
36+
# from the view of cargo-deny. This is an extremely heavy hammer, as if a crate
37+
# is pruned from the graph, all of its dependencies will also be pruned unless
38+
# they are connected to another crate in the graph that hasn't been pruned,
39+
# so it should be used with care. The identifiers are [Package ID Specifications]
40+
# (https://doc.rust-lang.org/cargo/reference/pkgid-spec.html)
41+
#exclude = []
42+
# If true, metadata will be collected with `--all-features`. Note that this can't
43+
# be toggled off if true, if you want to conditionally enable `--all-features` it
44+
# is recommended to pass `--all-features` on the cmd line instead
45+
all-features = false
46+
# If true, metadata will be collected with `--no-default-features`. The same
47+
# caveat with `all-features` applies
48+
no-default-features = false
49+
# If set, these feature will be enabled when collecting metadata. If `--features`
50+
# is specified on the cmd line they will take precedence over this option.
51+
#features = []
52+
53+
# The output table provides options for how/if diagnostics are outputted
54+
[output]
55+
# When outputting inclusion graphs in diagnostics that include features, this
56+
# option can be used to specify the depth at which feature edges will be added.
57+
# This option is included since the graphs can be quite large and the addition
58+
# of features from the crate(s) to all of the graph roots can be far too verbose.
59+
# This option can be overridden via `--feature-depth` on the cmd line
60+
feature-depth = 1
61+
62+
# This section is considered when running `cargo deny check advisories`
63+
# More documentation for the advisories section can be found here:
64+
# https://embarkstudios.github.io/cargo-deny/checks/advisories/cfg.html
65+
[advisories]
66+
# The path where the advisory databases are cloned/fetched into
67+
db-path = "$CARGO_HOME/advisory-dbs"
68+
# The url(s) of the advisory databases to use
69+
db-urls = ["https://github.com/rustsec/advisory-db"]
70+
# A list of advisory IDs to ignore. Note that ignored advisories will still
71+
# output a note when they are encountered.
72+
ignore = [
73+
#"RUSTSEC-0000-0000",
74+
#{ id = "RUSTSEC-0000-0000", reason = "you can specify a reason the advisory is ignored" },
75+
#"a-crate-that-is-yanked@0.1.1", # you can also ignore yanked crate versions if you wish
76+
#{ crate = "a-crate-that-is-yanked@0.1.1", reason = "you can specify why you are ignoring the yanked crate" },
77+
]
78+
# If this is true, then cargo deny will use the git executable to fetch advisory database.
79+
# If this is false, then it uses a built-in git library.
80+
# Setting this to true can be helpful if you have special authentication requirements that cargo-deny does not support.
81+
# See Git Authentication for more information about setting up git authentication.
82+
#git-fetch-with-cli = true
83+
84+
# This section is considered when running `cargo deny check licenses`
85+
# More documentation for the licenses section can be found here:
86+
# https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html
87+
[licenses]
88+
# List of explicitly allowed licenses
89+
# See https://spdx.org/licenses/ for list of possible licenses
90+
# [possible values: any SPDX 3.11 short identifier (+ optional exception)].
91+
allow = [
92+
"MIT",
93+
"Apache-2.0",
94+
"Unicode-3.0",
95+
"ISC"
96+
]
97+
# The confidence threshold for detecting a license from license text.
98+
# The higher the value, the more closely the license text must be to the
99+
# canonical license text of a valid SPDX license file.
100+
# [possible values: any between 0.0 and 1.0].
101+
confidence-threshold = 0.8
102+
# Allow 1 or more licenses on a per-crate basis, so that particular licenses
103+
# aren't accepted for every possible crate as with the normal allow list
104+
exceptions = [
105+
# Each entry is the crate and version constraint, and its specific allow
106+
# list
107+
#{ allow = ["Zlib"], crate = "adler32" },
108+
]
109+
110+
# Some crates don't have (easily) machine readable licensing information,
111+
# adding a clarification entry for it allows you to manually specify the
112+
# licensing information
113+
#[[licenses.clarify]]
114+
# The package spec the clarification applies to
115+
#crate = "ring"
116+
# The SPDX expression for the license requirements of the crate
117+
#expression = "MIT AND ISC AND OpenSSL"
118+
# One or more files in the crate's source used as the "source of truth" for
119+
# the license expression. If the contents match, the clarification will be used
120+
# when running the license check, otherwise the clarification will be ignored
121+
# and the crate will be checked normally, which may produce warnings or errors
122+
# depending on the rest of your configuration
123+
#license-files = [
124+
# Each entry is a crate relative path, and the (opaque) hash of its contents
125+
#{ path = "LICENSE", hash = 0xbd0eed23 }
126+
#]
127+
128+
[licenses.private]
129+
# If true, ignores workspace crates that aren't published, or are only
130+
# published to private registries.
131+
# To see how to mark a crate as unpublished (to the official registry),
132+
# visit https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field.
133+
ignore = false
134+
# One or more private registries that you might publish crates to, if a crate
135+
# is only published to private registries, and ignore is true, the crate will
136+
# not have its license(s) checked
137+
registries = [
138+
#"https://sekretz.com/registry
139+
]
140+
141+
# This section is considered when running `cargo deny check bans`.
142+
# More documentation about the 'bans' section can be found here:
143+
# https://embarkstudios.github.io/cargo-deny/checks/bans/cfg.html
144+
[bans]
145+
# Lint level for when multiple versions of the same crate are detected
146+
multiple-versions = "warn"
147+
# Lint level for when a crate version requirement is `*`
148+
wildcards = "allow"
149+
# The graph highlighting used when creating dotgraphs for crates
150+
# with multiple versions
151+
# * lowest-version - The path to the lowest versioned duplicate is highlighted
152+
# * simplest-path - The path to the version with the fewest edges is highlighted
153+
# * all - Both lowest-version and simplest-path are used
154+
highlight = "all"
155+
# The default lint level for `default` features for crates that are members of
156+
# the workspace that is being checked. This can be overridden by allowing/denying
157+
# `default` on a crate-by-crate basis if desired.
158+
workspace-default-features = "allow"
159+
# The default lint level for `default` features for external crates that are not
160+
# members of the workspace. This can be overridden by allowing/denying `default`
161+
# on a crate-by-crate basis if desired.
162+
external-default-features = "allow"
163+
# List of crates that are allowed. Use with care!
164+
allow = [
165+
#"ansi_term@0.11.0",
166+
#{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is allowed" },
167+
]
168+
# List of crates to deny
169+
deny = [
170+
#"ansi_term@0.11.0",
171+
#{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is banned" },
172+
# Wrapper crates can optionally be specified to allow the crate when it
173+
# is a direct dependency of the otherwise banned crate
174+
#{ crate = "ansi_term@0.11.0", wrappers = ["this-crate-directly-depends-on-ansi_term"] },
175+
]
176+
177+
# List of features to allow/deny
178+
# Each entry the name of a crate and a version range. If version is
179+
# not specified, all versions will be matched.
180+
#[[bans.features]]
181+
#crate = "reqwest"
182+
# Features to not allow
183+
#deny = ["json"]
184+
# Features to allow
185+
#allow = [
186+
# "rustls",
187+
# "__rustls",
188+
# "__tls",
189+
# "hyper-rustls",
190+
# "rustls",
191+
# "rustls-pemfile",
192+
# "rustls-tls-webpki-roots",
193+
# "tokio-rustls",
194+
# "webpki-roots",
195+
#]
196+
# If true, the allowed features must exactly match the enabled feature set. If
197+
# this is set there is no point setting `deny`
198+
#exact = true
199+
200+
# Certain crates/versions that will be skipped when doing duplicate detection.
201+
skip = [
202+
#"ansi_term@0.11.0",
203+
#{ crate = "ansi_term@0.11.0", reason = "you can specify a reason why it can't be updated/removed" },
204+
]
205+
# Similarly to `skip` allows you to skip certain crates during duplicate
206+
# detection. Unlike skip, it also includes the entire tree of transitive
207+
# dependencies starting at the specified crate, up to a certain depth, which is
208+
# by default infinite.
209+
skip-tree = [
210+
#"ansi_term@0.11.0", # will be skipped along with _all_ of its direct and transitive dependencies
211+
#{ crate = "ansi_term@0.11.0", depth = 20 },
212+
]
213+
214+
# This section is considered when running `cargo deny check sources`.
215+
# More documentation about the 'sources' section can be found here:
216+
# https://embarkstudios.github.io/cargo-deny/checks/sources/cfg.html
217+
[sources]
218+
# Lint level for what to happen when a crate from a crate registry that is not
219+
# in the allow list is encountered
220+
unknown-registry = "warn"
221+
# Lint level for what to happen when a crate from a git repository that is not
222+
# in the allow list is encountered
223+
unknown-git = "warn"
224+
# List of URLs for allowed crate registries. Defaults to the crates.io index
225+
# if not specified. If it is specified but empty, no registries are allowed.
226+
allow-registry = ["https://github.com/rust-lang/crates.io-index"]
227+
# List of URLs for allowed Git repositories
228+
allow-git = []
229+
230+
[sources.allow-org]
231+
# github.com organizations to allow git sources for
232+
github = []
233+
# gitlab.com organizations to allow git sources for
234+
gitlab = []
235+
# bitbucket.org organizations to allow git sources for
236+
bitbucket = []

examples/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ fn main() -> Result<(), StackerError> {
5050
println!("Calculated sharpness() in {:?}", now.elapsed());
5151

5252
// sort images by sharpness using TENG for now
53-
files.sort_by_key(|f| ordered_float::OrderedFloat(f.3));
53+
files.sort_by(|a, b| a.3.partial_cmp(&b.3).unwrap_or(std::cmp::Ordering::Equal));
5454

5555
println!("Files ordered by TENG (low quality first)");
5656
for f in files.iter() {

0 commit comments

Comments
 (0)