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

Extend requirements file in a manner, that we can run the tests locally #461

Closed
kainszs opened this issue Mar 30, 2024 · 4 comments
Closed

Comments

@kainszs
Copy link
Contributor

kainszs commented Mar 30, 2024

Hi,
I noticed while working on the last issue that I had to install additional modules to run the tests locally. I used the github actions as a guide.

Can we cover this via the requirements.txt? This does not affect the project.toml, but only for developers of the project who install it from the repository.

@Blastorios
Copy link
Contributor

Do you mean the dev dependencies? They are defined the pyproject.toml and can be installed using

poetry install --with dev

Perhaps it would help to add this step to the Contributing section inside the README.

@BradyAJohnston
Copy link
Owner

The requirements.txt is just for use by the add-on inside of Blender, to generate the list of python packages which need to be installed. The required packages for installing via pip and for development are defined in the pyproject.toml.

I don't like that the packages & versions are defined twice - but currently the add-on is created from the molecularnodes/ folder, and only has access to the contents of that folder. Supporting it as both an add-on and a pypi package currently means we have to define in two places (unless someone knows a smart way to resolve this)

@BradyAJohnston
Copy link
Owner

And yes @Blastorios this should be defined in the Contributing section. I'll prioritise putting together more contributing documentation over the next couple of days.

@BradyAJohnston
Copy link
Owner

Added a CONTRIBUTING.md in #463 . I welcome input on what should also be covered / what should be made more clear. As more questions around development are answered I can ensure that they also go in there.

@kainszs kainszs closed this as completed Mar 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants