`kalamine create` does not work on a fresh install

[fabi1cazenave]

kalamine create expects to find layout templates in a layouts subdirectory that is not published.

[fabi1cazenave]

Re-opening. I need a proper way to test this locally.

[fabi1cazenave]

Looks like we’re doing the most basic beginner mistake here by loading files relative to the source file.

https://stackoverflow.com/a/58941536

[fabi1cazenave]

This is becoming an epic failure. :-)

TIL: the idea of implementing kalamine create by grabbing the user guide from docs/ and layout descriptors from layouts/ cannot work.

What I’ve learned so far :

• the current file structure is fine as long as we understand that only the content of the kalamine/ subdirectory will be deployed ;
• it’s technically doable to deploy docs/ and layouts/ by adding them to the wheel — that’s what we did before with MANIFEST.in, and lately with the [tool.hatch.build.targets.wheel] section in pyproject.coml — but it results in installing these directories directly into the user’s site-packages and I’m still surprised this can even be allowed by pip ;
• using pathlib to grab resources from the package is not OK, pkgutil should be used instead.

So what should we do now ?

• backout the recent patches so that the KeyboardLayout constructor uses a pathlib.Path argument (e.g. layout.py + tests/) ;
• keep the sane pkgutil approach to load anything within the kalamine/ subdirectory (e.g. data/, tpl/) ;
• generate the User Guide from kalamine rather than importing it:
  • README sections could be stored in data/ and reused by kalamine create ;
  • the whole deadkey description part should be generated from data/dead_keys.yaml ;
  • a README template could be stored in tpl/ ;
  • a make_user_guide.py script could be stored in the root directory and called by make publish ;
• think of a way to create a KeyboardLayout instance without any YAML/TOML descriptor, possibly by grabbing stuff from the data/ subdirectory instead.

This should probably done with several PRs.