improving setup.py and friends

vislearn / FrEIA

Framework for Easily Invertible Architectures

MIT License

775 stars 113 forks source link

improving setup.py and friends #64

Open psteinb opened 3 years ago

psteinb commented 3 years ago

while working on the unit tests, I had a look at setup.py which is basically empty. This makes use of the package, dependency handling and much more a bit demanding going forward.

For now, I see two options:

expand on the use of setup.py for the time being. As long as there is no C/C++ code being compiled during the build, I would however discourage that.
start using tools like flit or poetry. The latter is a tool that we made good experiences with so far. But that would mean, that those people doing releases etc would have to learn this.

Thoughts / wishes / decisions ?

psteinb commented 3 years ago

See also the setuptools docs for a hint at the discussion on setup.py, setup.cfg, pyproject.toml, ... https://setuptools.readthedocs.io/en/latest/setuptools.html

ardizzone commented 3 years ago

Hmm.... I have no idea about these kinds of things, all I can say from our side on the topic:

I think it's good if managing the packaging and setup process is as simple as possible, because students join and leave on a month-by-month basis, and may not be able to invest the time into learning advanced tools.
I don't see the project becoming hugely more complex in terms of custom c code, many dependencies, etc., in the foreseeable future. So we may not need a super powerful tool.

I don't know how this relates to setuptools, flit, poetry, wich of those is simpler to use, and so on.

psteinb commented 3 years ago

I completely understand. I took the liberty and followed the first path I suggested earlier in #63 and expanded the setup.py for now.

psteinb commented 3 years ago

feel free to either close this issue or leave it open to remind people.

ardizzone commented 3 years ago

I'll leave it open in case there are further opinions! ;)