kantord/SeaGOAT

Support Windows. Help wanted 馃檹馃獰

Open

#179 opened on Sep 7, 2023

聽(13 comments)聽(2 reactions)聽(0 assignees)Python聽(91 forks)github user discovery
help wantedup for grabs

Repository metrics

Stars
聽(1,302 stars)
PR merge metrics
聽(No merged PRs in 30d)

Description

At all steps, SeaGOAT is developed with the intention of guaranteeing Windows support. That being said, as I don't have a Windows device and I don't have expertise regarding Windows development workflows, I have not been able to verify that it works properly on Windows.

The main goal is to support WSL, but supporting Windows natively is also a goal if it's possible!

Help wanted!

Here is a rough checklist of the current status of Windows support:

  • Enable CI checks for Windows
  • Enable tests for WSL if it's possible and necessary with GitHub actions
  • Make sure that all CI tests pass for Windows
  • Manually test SeaGOAT on Windows
  • Document installation steps on Windows
  • Make sure that any required Windows-specific features are implemented
  • Ensure it's easy to install on Windows using common tools
  • Currently, the main problem is that I have not been able to try and run SeaGOAT manually on Windows.

Also, I have discovered that some of the tests are failing on Windows. So, I created a CI file specifically for Windows that only checks some of the tests that are passing without issue:

https://github.com/kantord/SeaGOAT/blob/1edae8e4b9272906300046cf99bb5de8fd4256aa/.github/workflows/test-windows.yml#L56-L58

For comparison, the Linux tests look like this:

https://github.com/kantord/SeaGOAT/blob/1edae8e4b9272906300046cf99bb5de8fd4256aa/.github/workflows/test.yml#L56-L58

Contributor guide