Assorted chores

[piotr-roslaniec]

Type of PR:

• Other

Required reviews:

• 1

What does it do:

• Fixes a bunch of smaller chores
• Removes support for deprecated Python versions, adds support for Python 3.12
• Adds a CI job to compile benchmarks without running them (benchmarks were disabled a while back because there was some issue with report uploading)
• Removes unused curves (unused code) from the codebase

Issues fixed/closed:

• Fixes Derive Eq for DkgPublicKey #157
• Fixes Rename group_threshold_cryptography crate to ferveo-tpke #164
• Fixes Add .pyi file linting #141
• Fixed Delete references to ed25519 #167
• Refers to: Indicate support for python 3.12 nucypher-core#87

[codecov-commenter]

Codecov Report

Merging #166 (58002f5) into main (13d9d26) will increase coverage by 0.05%.
The diff coverage is 97.77%.

@@            Coverage Diff             @@
##             main     #166      +/-   ##
==========================================
+ Coverage   77.95%   78.01%   +0.05%     
==========================================
  Files          23       23              
  Lines        5053     5066      +13     
==========================================
+ Hits         3939     3952      +13     
  Misses       1114     1114              

Files	Coverage Δ
ferveo-common/src/keypair.rs	72.97% <100.00%> (+0.53%)	⬆️
ferveo-tdec/src/ciphertext.rs	97.95% <ø> (ø)
ferveo-tdec/src/combine.rs	98.51% <ø> (ø)
ferveo-tdec/src/context.rs	98.03% <ø> (ø)
ferveo-tdec/src/decryption.rs	70.72% <ø> (ø)
ferveo-tdec/src/hash_to_curve.rs	100.00% <ø> (ø)
ferveo-tdec/src/key_share.rs	32.60% <ø> (ø)
ferveo-tdec/src/lib.rs	99.78% <ø> (ø)
ferveo-tdec/src/secret_box.rs	63.15% <ø> (ø)
ferveo/src/api.rs	88.93% <100.00%> (+0.02%)	⬆️
... and 6 more

... and 1 file with indirect coverage changes

[cygnusv]

@piotr-roslaniec what do you think of ferveo-tdec instead of ferveo-tpke? I know that I suggested it, but in retrospective I don't know why I didn't think of that before!

[piotr-roslaniec]

@cygnusv Makes sense, also tpke doesn't quite roll off the tongue. I will update this PR shortly.

[cygnusv]

Ah, so refreshing!

[cygnusv]

README still refers to tpke

[cygnusv]

This remind me of a situation a couple of months ago that was making me crazy when working with Ferveo until I realized (or actually, you pointed out). Even though the package and directory are called ferveo-tdec, the crate is automatically renamed to ferveo_tdec. Do you think it would be worth to rename everything to underscores?

[piotr-roslaniec]

Using both - and _ as a separator in crate names is fine. There is a debate on setting the naming convention.

I'm fine with renaming all crates, we have to republish them anyway. The directories should remain named according to the kebab-case.

[piotr-roslaniec]

I've documented this as a todo here: #122

[cygnusv]

The directories should remain named according to the kebab-case

Why?

[piotr-roslaniec]

Well, I can't cite any specific source on that, but I think it's a cargo project convention. I think, very generally speaking, top-level modules (including *.rs files) are to use kebab-case and non-top-level files (never directories) are to use snake_case.