Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvement: Make the CLI work on windows #54

Open
cyclotruc opened this issue Dec 24, 2024 · 1 comment
Open

Improvement: Make the CLI work on windows #54

cyclotruc opened this issue Dec 24, 2024 · 1 comment
Labels
help wanted Extra attention is needed planned This will be implemented suggestion New feature or request

Comments

@cyclotruc
Copy link
Owner

I did't have windows in mind when I started this; and I have little to no experience on that matter, so any help on this matter would be greatly appreciated.

I think Windows user for the Pypi package (CLI or python module) will be more and more common, since it's often the platform of beginners who use gitingest to learn about codebases

From the few tests I did it seems that \ and things such as C: in paths are not handled
This should be easily solvable by using the proper os API or maybe pathlib

@cyclotruc cyclotruc added suggestion New feature or request help wanted Extra attention is needed planned This will be implemented labels Dec 24, 2024
@gustaveWPM
Copy link

gustaveWPM commented Dec 26, 2024

Hummm...
It's a common and frustrating issue.

I think a good way to fix it would also be to write unit tests that cover all the CLI features that handle paths and other OS-specific details.


It would then be possible to test them across multiple operating systems (Windows, macOS, Linux) using a Matrix in a GitHub Action.
https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/running-variations-of-jobs-in-a-workflow

As it has been done to check several Python versions here: https://github.com/cyclotruc/gitingest/blob/main/.github/workflows/unitest.yml#L14

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed planned This will be implemented suggestion New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants