Code formatting in CI

[ibrahiminfinite]

Will close #55

[sea-bass]

Thanks for kicking this off!

This might end up being a bigger PR than expected, since adding a GitHub action to run Black means all the code will have to be auto-formatted :)

[ibrahiminfinite]

The Github action seems to be working for black.
It is currently set to fail the workflow if files need to be edited.

[ibrahiminfinite]

@sea-bass
The diff output for Black looks good to me (https://github.com/sea-bass/pyrobosim/actions/runs/3898671363/jobs/6657630984)
If this looks okay to you , we can proceed to enable the auto-formatting.

[sea-bass]

Thanks for getting this started!

I meant to do this and have a lot of particular preferences (sorry), so here you go :)

[ibrahiminfinite]

Looks like it is working directly with pre-commit now.
The diffs are also looking good.

[sea-bass]

Looks like it is working directly with pre-commit now. The diffs are also looking good.

Yes they are, this is so cool to see!

I'll leave it up to you if you want to actually do all the formatting changes; else, we can merge this as-is and I can update with the suggestions in a follow-on PR.

[ibrahiminfinite]

Do you mean the formatting changes suggested by Black ?

[sea-bass]

Small stuff.

Again, I'm happy to approve it after this if you don't want to actually commit the formatting suggestions as part of this PR, but up to you.

[ibrahiminfinite]

Small stuff.

Again, I'm happy to approve it after this if you don't want to actually commit the formatting suggestion as part of this PR, but up to you.

No problem. will add the suggested changes by Black to this PR itself.

[sea-bass]

No problem. will add the suggested changes by Black to this PR itself.

Maybe you already know this, but just in case!

If you install pre-commit (https://pre-commit.com/) and then run this from the repo root,

pre-commit run -a

it will do all the changes automatically.

[ibrahiminfinite]

The Format workflow is failing since this branch was made before the world modeling tests were merged and so does not include the 'test_world.py' which is in main.
Might have to fix formatting for the test_world.py and world.py in another PR.
Or is it possible to fix it here ?

[sea-bass]

You can merge my repo's main branch into yours. Let me do that right now!

Also, I guess pre-commit doesn't automatically add shebangs to shell scripts. Added those too.

[ibrahiminfinite]

It passed !
That is cool

[sea-bass]

If the test_pddlstream_manip unit tests fail (they have been recently), it's something hopefully fixed by #57, so we can merge this anyway.

Thank you so much for doing this!