search

CaringCaribou / caringcaribou

A friendly car security exploration tool for the CAN bus
GNU General Public License v3.0
751 stars 197 forks source link

Python package - refactor #78

Closed alasjo closed 1 year ago

alasjo commented 1 year ago

This PR is an attempt to implement setuptools in CaringCaribou to eventually make it pip installable, but for now at least runnable from anywhere, installed as a global package or in a virtual environment.

There have been changes in the file structure, some refactoring and changes in documentation. The /tool directory has been renamed to caringcaribou as per convention, and the lib directory has been renamed to utils. Tests and module template have also been moved. A setup.py script has been added.

Having run python setup.py install the console entry points cc.py -h and caringcaribou -h both work from anywhere.

Would be glad to get some feedback, having it tested etc. (I've tested the UDS module on a NXP dev board at least).

Package metadata needs to be reviewed...

Also refer to issue #67 where this feature was requested.

<3

kasperkarlsson commented 1 year ago

Hey @alasjo - these changes would be great to finally get in place, so your PR is most welcome!

I will try to find a slot to review this as soon as possible 😺

alasjo commented 1 year ago

Thank you for your comments, Kasper! I tried to fix the issues and just recently pushed my changes.

kasperkarlsson commented 1 year ago

Thank you for this huge improvement to the project's structure 🥳🤘