🔧 Improve packaging tooling

[s-weigand]

This fixes changelog.md missing from the tarball and adds an additional tool to check that all need files are included in the distribution.

Change summary

• 🩹 Changed old HISTORY.rst to changelog.md in manifest
• 🔧 Added 'check-manifest' pre-commit hook to check for missing files in the distribution

Checklist

• ✔️ Passing the tests (mandatory for all PR's)
• 🚧 Added changes to changelog (mandatory for all PR's

[github-actions]

👈 Launch a binder notebook on branch s-weigand/pyglotaran/improve-packaging

[s-weigand]

I made it a draft because I want #922 merged first, so I can add the change to the changelog 😉

[github-actions]

Benchmark is done. Checkout the benchmark result page.
Benchmark differences below 5% might be due to CI noise.

Benchmark diff v0.5.1 vs. main

Parametrized benchmark signatures:

BenchmarkOptimize.time_optimize(index_dependent, grouped, weight)

All benchmarks:

       before           after         ratio
     [96b42630]       [d6e64003]
     <v0.5.1>                   
       50.9±0.2ms       51.8±0.3ms     1.02  BenchmarkOptimize.time_optimize(False, False, False)
       54.8±0.6ms        60.0±10ms     1.10  BenchmarkOptimize.time_optimize(False, False, True)
       51.0±0.3ms       51.9±0.3ms     1.02  BenchmarkOptimize.time_optimize(False, True, False)
       55.4±0.5ms       55.6±0.4ms     1.00  BenchmarkOptimize.time_optimize(False, True, True)
       61.9±0.2ms       62.9±0.2ms     1.02  BenchmarkOptimize.time_optimize(True, False, False)
         65.7±5ms       66.6±0.6ms     1.01  BenchmarkOptimize.time_optimize(True, False, True)
       62.2±0.4ms       62.7±0.3ms     1.01  BenchmarkOptimize.time_optimize(True, True, False)
        65.6±30ms       66.9±0.5ms     1.02  BenchmarkOptimize.time_optimize(True, True, True)
             193M             195M     1.01  IntegrationTwoDatasets.peakmem_optimize
       1.72±0.06s       1.75±0.05s     1.02  IntegrationTwoDatasets.time_optimize

Benchmark diff main vs. PR

Parametrized benchmark signatures:

BenchmarkOptimize.time_optimize(index_dependent, grouped, weight)

All benchmarks:

       before           after         ratio
     [48ed9cf3]       [d6e64003]
       51.2±0.6ms       51.8±0.3ms     1.01  BenchmarkOptimize.time_optimize(False, False, False)
       54.9±0.6ms        60.0±10ms     1.09  BenchmarkOptimize.time_optimize(False, False, True)
       51.1±0.1ms       51.9±0.3ms     1.01  BenchmarkOptimize.time_optimize(False, True, False)
         55.2±1ms       55.6±0.4ms     1.01  BenchmarkOptimize.time_optimize(False, True, True)
       62.6±0.3ms       62.9±0.2ms     1.01  BenchmarkOptimize.time_optimize(True, False, False)
       65.8±0.5ms       66.6±0.6ms     1.01  BenchmarkOptimize.time_optimize(True, False, True)
       62.3±0.4ms       62.7±0.3ms     1.01  BenchmarkOptimize.time_optimize(True, True, False)
        66.4±20ms       66.9±0.5ms     1.01  BenchmarkOptimize.time_optimize(True, True, True)
             197M             195M     0.99  IntegrationTwoDatasets.peakmem_optimize
       1.67±0.04s       1.75±0.05s     1.05  IntegrationTwoDatasets.time_optimize

[codecov]

Codecov Report

Merging #923 (d6e6400) into main (48ed9cf) will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##            main    #923   +/-   ##
=====================================
  Coverage   85.1%   85.1%           
=====================================
  Files         85      85           
  Lines       4799    4799           
  Branches     921     921           
=====================================
  Hits        4085    4085           
  Misses       562     562           
  Partials     152     152           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 48ed9cf...d6e6400. Read the comment docs.

[jsnel]

I made it a draft because I want #922 merged first, so I can add the change to the changelog 😉

#922 is merged, so that can be done now ^^

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
1.5% Duplication

[jsnel]

Good improvements!