Feature/python best practices

epfl-lasa / wiki

Best practices, conventions, manuals and instructions for researchers at the LASA

5 stars 1 forks source link

Feature/python best practices #4

Closed domire8 closed 1 year ago

domire8 commented 3 years ago

I know there is not a lot ROS python know-how around here but we have to build that up, thats why I added you as reviewers.

This PR essentially adds a template package for ROS with Python to the code of the wiki. It lacks explanations and examples, we can work on that progressively. If you accept, I will merge and we can start from here.

Most important TODOs:

add examples to showcase advantages of this structure
explanations and hints
best practices when adopting this structure
further: how to make sure that local dependencies (python packages installed via pip or similar) are declared within the package (--> docker?)

domire8 commented 3 years ago

@buschbapti do you think it would be useful if i created a Dockerfile for such a package too or is that not really useful at this stage, knowing that not a lot of people use python?

hubernikus commented 3 years ago

Is this branch still active? I was looking into extending the best practices & git-repo creation for better & more maintainable python code

domire8 commented 3 years ago

Is this branch still active? I was looking into extending the best practices & git-repo creation for better & more maintainable python code

Nah not really, I guess most of it is still true but if you want to add stuff that would be great! you can do it on a seperate branch

hubernikus commented 3 years ago

Aah, but this branch is only for the repository / templates anyways. And otherwise it's the https://github.com/epfl-lasa/wiki/wiki repo. (Where branching does not really do much anyway...)

domire8 commented 3 years ago

Aah, but this branch is only for the repository / templates anyways. And otherwise it's the https://github.com/epfl-lasa/wiki/wiki repo. (Where branching does not really do much anyway...)

Well if you want to read a guide or similar (not code), you should do it on https://wiki.epfl.ch/lasa because we'd like to keep things private and we can only have a wiki here if it's public.