Issues for Setting Up the Development Environment

[zhjjtour-hub]

Hi Joan and others,

First of all, many thanks for providing the excellent codes for generating G-codes with advanced functionalities. While I haven't yet practically use the gscrib, the key features make me exciting, as those are key parts for CNC machining.

Then, I tried to install and run the gscirb by following the instructions. However, I am encountering errors at setting up the development environment, although I exactly followed the instructions in the section of Setting Up the Development Environment, as:
git clone https://github.com/joansalasoler/gscrib.git (Success)
cd gscrib
poetry install --with dev,docs (Success)
Invoke-Expression (poetry env activate) (Ending with nothing displayed)

Then I tried to run the test suite by following command:
poetry run pytest
However, it wasn't successful with the infor: Interrupted: 22 errors during collection, as seen in the attached files of snapshot and log file. I checked the log file and found that the main problem seems is associated with the error: ModuleNotFoundError: No module named 'gscrib'

Pytest errors.txt

Could you kindly check the problem at your best convenience? Many thanks!

Best regards,
Junjie

[joansalasoler]

Please ensure there is an empty __init__.py file inside the ./tests folder, then try running the tests again. This is most likely the cause of the errors on Windows. Note that this issue has been fixed on the develop branch but has not yet been merged into main.

[zhjjtour-hub]

Please ensure there is an empty __init__.py file inside the ./tests folder, then try running the tests again. This is most likely the cause of the errors on Windows. Note that this issue has been fixed on the develop branch but has not yet been merged into main.

Hi Joan, thanks for the reply. Indeed, there is no such init.py file in the tests folder, I will then create the file and try again. BTW, if I would like to continue with the gscrib, whether I must successfully run the test, or I could simply jump over it?

[zhjjtour-hub]

Please ensure there is an empty __init__.py file inside the ./tests folder, then try running the tests again. This is most likely the cause of the errors on Windows. Note that this issue has been fixed on the develop branch but has not yet been merged into main.

Hi Joan, I tried to run the test again following your above instruction, seems that a large progress was made, as 404 passed, 8 failed, and 2 warnings. I have no idea about the 8 errors, could you kindly check how to fix it? Many thanks!

[joansalasoler]

Thanks for trying that out, and glad to hear most of the tests are now passing.

Just to clarify, a fix for this was already pushed to the develop branch, and I've also attached it to this issue so you can apply it directly if needed (see above).

If you need more context on how the project is structured or how the tests are intended to be run, the documentation here may help:

• Official docs: https://gscrib.readthedocs.io/
• AI-generated wiki docs: https://deepwiki.com/joansalasoler/gscrib

Also, please note that you do not need the unit tests to fully pass for the project to work correctly. The remaining failures you're seeing are due to some test bugs that appear when running under Windows, rather than problems with your setup.

[zhjjtour-hub]

Thanks for trying that out, and glad to hear most of the tests are now passing.

Just to clarify, a fix for this was already pushed to the develop branch, and I've also attached it to this issue so you can apply it directly if needed (see above).

If you need more context on how the project is structured or how the tests are intended to be run, the documentation here may help:

• Official docs: https://gscrib.readthedocs.io/
• AI-generated wiki docs: https://deepwiki.com/joansalasoler/gscrib

Also, please note that you do not need the unit tests to fully pass for the project to work correctly. The remaining failures you're seeing are due to some test bugs that appear when running under Windows, rather than problems with your setup.

Thanks for the comments, particularly the last one, it let me know my steup is now ready for starting the gscrib project. Then, I stop the running unit tests at the current stage, and move forward to the project itself. Thanks for the help!

[zhjjtour-hub]

The remaining failures you're seeing are due to some test bugs that appear when running under Windows, rather than problems with your setup.

Hi Joan, this comment indeed touched me to think about the OS for gscrib, seems that Windows is not the preferred one. I will then turn to Linux, which distribution do you recommend or prefer for gscrib? Thanks!