*This began with https://github.com/leo-editor/leo-editor/issues/573
<https://github.com/leo-editor/leo-editor/issues/573>*
QQQ
I've been doing a lot of reading and asking questions about the current
state of python packaging and best practice and it's application to Leo.
What follows is my best current understanding.
Our current dir structure more or less:
\---app
\---docs
\---py-modules
\---core
\---extras
When we build a *source distribution* (python setup.py sdist) that entire
structure and contents are stuffed into a tar archive. (At least it does
now with the setup.py post ~Oct-2017)
*However* after pip install app-0.1.tar.gz this is what is received:
PYTHONHOME\Lib\site-packages
\---py-modules
\---core
A *wheel* has the same result (a wheel basically the above two steps
combined into one and pre-compiled for distribution).
I asked https://gitter.im/pypa/setuptools if there was a way to just have
pip use app as the root parent instead of py-modules, since if we manually
copy the whole folder tree everything will just work. (Modulo cumbersome
mechanism of having to start with python path\to\app\launch.py.)
The answer? *You just can't do that. extras must live under app.*
(You can fake it by putting an empty __init__.py in extra, but then it will
get put into PYTHONHOME\Lib\site-packages along side app at same level,
polluting the name space.)
...
So where does this leave us?
-
Do nothing. In it's current state pip install Leo succeeds, the end user
has a fully functioning application (so far as we know, given the light
testing to date), but some (developer-specific?) files are unavailable.
-
Follow recommendation, move everything in the root folder outside of
Readme, License and Setup into leo/something, and then update all of
Leo's internal link references and workflows to match.
- ...?
QQQ
I've come up with a handful of arguments for and against both, but this
message is already long. ;-) Your thoughts appreciated.
--Matt
--
You received this message because you are subscribed to the Google Groups
"leo-editor" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/leo-editor.
For more options, visit https://groups.google.com/d/optout.
