Add DEBIAN_SETUP.md to support Debian and WSL environments (Fixes #1091)#1099
Add DEBIAN_SETUP.md to support Debian and WSL environments (Fixes #1091)#1099Schronding wants to merge 2 commits intomalariagen:masterfrom
Conversation
|
There are currently several setup guides, one for Mac, Linux, and the general contributing guide. It would be good to have a single guide that works for everyone as much as possible. The Contributing.md guide suggests installing python with poetry, do you know if that works on Debian? (Incidentally I agree that uv is better, but since we have poetry already it's probably simplest to stick to a single tool for now.) |
27f3050 to
490a0a6
Compare
|
@jwgarber Thank you so much for your comment! I have checked my solution again and I understand the source of the problem now. There were some things that I misunderstood.
As I know the MalariaGEN team is very busy, I went ahead and modified the file directly with the changes so you can tell me if there is another problem. The reason why I am leaving the local installation in Her commit says:
|
|
Hey @jwgarber and @jonbrenas, I am quite proud of the work I've done here. I focused mainly on developing as universal a guide as possible for 5 different Linux distributions. I have tested all of them myself, and I am happy to say that the steps work seamlessly, even on freshly installed environments. I also decided to remove the Installing the current project: malariagen_data (0.0.0)
Looks like you're trying to use a Poetry command that is not available.
Since Poetry (2.0.0), the shell command is not installed by default. You can use,
- the new env activate command (recommended); or
- the shell plugin to install the shell commandI am completely open to feedback or questions. Let me know your thoughts on this contribution! :D TestsUbuntu 24.04.4 LTS ==== 952 passed, 4 skipped, 234 warnings in 924.83s (0:15:24) =====
storm_trooper@StormTrooper:~/malariagen-data-python$ cat /etc/os-release
PRETTY_NAME="Ubuntu 24.04.4 LTS"Arch Linux ==== 952 passed, 4 skipped, 232 warnings in 869.90s (0:14:29) =====
[schronding@StormTrooper malariagen-data-python]$ cat /etc/os-release
NAME="Arch Linux"Fedora Linux 43 ==== 952 passed, 4 skipped, 231 warnings in 913.85s (0:15:13) =====
schronding@StormTrooper:~/malariagen-data-python$ cat /etc/os-release
NAME="Fedora Linux"Debian GNU/Linux 13 (trixie) ==== 952 passed, 4 skipped, 237 warnings in 922.34s (0:15:22) =====
schronding@StormTrooper:~/malariagen-data-python$ cat /etc/os-release
PRETTY_NAME="Debian GNU/Linux 13 (trixie)"Linux Mint ============ 952 passed, 4 skipped, 227 warnings in 773.05s (0:12:53) ============
root@1fb669b4cfc6:/malariagen-data-python# cat /etc/os-release
NAME="Linux Mint" |
Fixes #1091
What problem does this solve? The current
LINUX_SETUP.mdrelies on Launchpad PPAs, which are Ubuntu-specific and fail on Debian and other Linux distributions (detailed in #1091). This creates a barrier for contributors using non-Ubuntu environments.How does it solve it? This PR adds a dedicated
DEBIAN_SETUP.mdguide.pyenvin the original issue, further research showed thatuvis significantly faster and handles both Python installation and virtual environments seamlessly.uvas a global replacement for package management across the project, but since the test suite and repository heavily rely onpoetry, I decided to keepuvstrictly scoped to this Debian setup guide. I didn't want to make an irresponsible or disruptive change to the existing test architecture.Testing done
952 passed, 4 skipped, 241 warnings in 760.47s.Breaking changes or migration notes None. This is purely an additive documentation change. I am completely open to feedback or expanding this to cover more distributions if the team thinks it would be valuable!