Update build system to prepare for Flatpak release #254
Conversation
Add template to cover future use cases
Adding setup.py and pyproject.toml allows easier installation with native Python tooling
|
I'm still working on Flatpak support but I realized that my beta branch has gotten a bit out of date, so this PR is to get us in sync. |
|
Sorry, this got lost in my inbox. I pushed the changes you requested! |
setup.py
Outdated
| ], | ||
| python_requires='>=3.10', | ||
| install_requires=[ | ||
| 'psutil==5.9.5', |
There was a problem hiding this comment.
Can you try to collect the dependencies in a single location? With these changes, we would have three different entries to change with an update:
- requirements.txt
- setup.py and
- pyproject.toml.
It would be great if we could just rely on one location.
There was a problem hiding this comment.
My understanding of these files is that requirements.txt is for development and setup.py/pyproject.toml is for packaging/distribution, so I think we need to have at least two files? It does appear that pyproject.toml can completely replace setup.py but it is still recommended that both pyproject.toml and setup.py stick around1, but I would appreciate feedback from someone who is more knowledgeable on python packaging then myself.
Footnotes
There was a problem hiding this comment.
Actually, it appears that the modern recommendation is indeed to forego setup.py in favor of pyproject.toml, if scripting is not needed. I'll work on that now.
There was a problem hiding this comment.
My latest commit sets up the project to use poetry for building, which means we only need to have pyproject.toml. If you are on board with switching to poetry, I will need to also update the build documentation since the commands will change.
chase9
force-pushed
the
beta
branch
4 times, most recently
from
42c07ab
to
ebde87c
Compare
Builds off of 088434b, since the newer calls are not compatible with the older calls.
This also adds pytest and flake8 to DEV deps since they are needed for CI.
chase9
changed the title
|
Ok, the only thing left now is to update the instructions in the readme to use poetry, right? And then the wiki once its merged. |
|
I've updated the install script and README.md with the new instructions. Tested on a live ISO for Ubuntu 22.04 and everything worked! I do think that it would be cool to eventually do away with the current build instructions and instead be able to have users install using PIP or Flatpak. What do you think about this? |
|
Yes, definitely. I'd love to even go flatpak-only at some point, just to make bug reports more easily reproducable. |
The goal of this PR is to make adjustments needed for eventually building Yin-Yang into flatpak format.
Essentially, it makes some updates to how we build the application in order to modernize and prepare for building with Flatpak. The add-flatpak branch depends on this being merged first.
To-Do: