Migrate to pyproject.toml, activate towncrier, update release workflow

[jlaehne]

Description of the change

• Migrate to pyproject.toml to replace setup.py (see e.g. Consolidate package metadata in pyproject.toml, use setuptools_scm and add python 3.12 hyperspy/holospy#14)

• Activate towncrier for changelog (see e.g. Use towncrier and improve setting dev version hyperspy/holospy#17)

• Update release workflow to match the one of HyperSpy and other extensions. Related todo:

  • Set up trusted publisher on PyPI.
  • Disable PyPI token if new workflow works correctly.
  • Do we need to change anything on the zenodo setup?

Progress of the PR

• Change implemented (can be split into several points),
• docstring updated (if appropriate),
• update user guide (if appropriate),
• [n/a] added tests,
• added changelog entries to upcoming_changes,
• test formatting of changelog,
• ready for review.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (681442a) to head (dc82df1).
Report is 1 commits behind head on main.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #211   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           13        12    -1     
  Lines          565       552   -13     
=========================================
- Hits           565       552   -13     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jlaehne]

@ericpre is there a way to make the hyperspy package_and_test workflow available for lumispy or should I work on simplifying the copy made here instead? As far as I can see, in particular `l65 is incompatible with being called from outside the hyperspy organization.

[ericpre]

Can you try now after hyperspy/.github@c5376fc?

[jlaehne]

Can you try now after hyperspy/.github@c5376fc?

Still trying to run git remote add upstream https://github.com/hyperspy/lumispy.git:
https://github.com/LumiSpy/lumispy/actions/runs/8944482220/job/24571487005?pr=211

[jlaehne]

Can you try now after hyperspy/.github@c5376fc?

Still trying to run git remote add upstream https://github.com/hyperspy/lumispy.git: https://github.com/LumiSpy/lumispy/actions/runs/8944482220/job/24571487005?pr=211

OK, now I figured that I have to pass the ORGANISATION and it is running through :-)

[ericpre]

That looks all good and working as expected.

I think that it should be possible to remove the MANIFEST.in file.

• Do we need to change anything on the zenodo setup?

Not that I am aware of!

Is it worth updating the doc workflow? For example:

https://github.com/hyperspy/rosettasciio/blob/fa68311843db1e10d070d23c6691289c3b93ba32/.github/workflows/docs.yml#L1-L12

[jlaehne]

Is it worth updating the doc workflow? For example:

I see that the [push_doc.yml](https://github.com/hyperspy/.github/blob/main/.github/workflows/push_doc.yml) workflow relies on tokens that can probably not be shared across organisations?

[ericpre]

Which tokens?

This is the workflow:
https://github.com/hyperspy/.github/blob/main/.github/workflows/doc.yml

[jlaehne]

doc.yml uses push_doc.yml, which uses access tokens: https://github.com/hyperspy/.github/blob/c5376fc1205d57561ac5e15620df4e5799465a5c/.github/workflows/push_doc.yml#L83

I'll merge this PR and the doc workflow could become a new one.