search

CycodeLabs / raven

CI/CD Security Analyzer
Apache License 2.0
623 stars 33 forks source link

`library` folder not included in the source distribution #183

Open BastienFaure opened 5 months ago

BastienFaure commented 5 months ago

Describe the bug The library folder is not included in the source distribution built and sent to Pypi:

$ tar tf raven_cycode-1.0.9.tar.gz |grep library | wc -l
0

Thus, when installing raven-cycode using pip and the pypi repository, the library folder isn't available and causes certain commands to fail:

$ raven report --format raw 
2024-06-04 14:31:42 | ERROR    | [Errno 2] No such file or directory: 'library'

To Reproduce

$ pipx install raven-cycode
$ raven report --format raw

Expected behavior The library folder should be shipped in the source distribution by including them in the package's manifest and by instructing setuptools to include package data during installation. To my knowledge, this is possible only by moving the library folder into the source package tree, otherwise it will likely pollute the Python library namespace.

Screenshots If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

Additional context Side note, currently the package used the folder src in the Python package namespace, which is also confusing. I suggest it to be renamed to something like raven if it doesn't conflict with other packages namespaces, at least less likely than src.

elad-pticha commented 4 months ago

Hey and thank you for opening this issue, we will take a look