Skip to content

Auto formatting for real this time #443

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.

Sign up for GitHub

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

Open
Michael-Foley wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Auto formatting for real this time #443

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v6.0.0
hooks:
- id: check-yaml
- id: end-of-file-fixer
- id: trailing-whitespace
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.15.1
hooks:
- id: ruff-check
args: [ --fix ]
- id: ruff-format
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ First, you will need to log in to Nvidia NGC and get an API Key here: https://or
Then install Nvidia ngc CLI and make sure it is present in path: https://org.ngc.nvidia.com/setup/installers/cli

Follow the instructions on the website to install and configure ngc.

Test the ngc installation by running `ngc` in a new terminal. If it doesn't work, try adding `echo "export PATH=\"\$PATH:$(pwd)/ngc-cli\"" >> ~/.bash_profile && source ~/.bash_profile` to your `~/.bashrc` file.

Then log in to nvcr with the following command:
Expand Down Expand Up @@ -151,12 +151,19 @@ To normalize line endings in git, use the command:
git config --global core.autocrlf true
```

The formatter the codebase uses is ruff. Run `pip install ruff` to install ruff.

To have ruff automatically run on commit use pre-commit.

To install pre-commit run `pip install pre-commit`, then run `pre-commit install` to have the hooks installed. Now any time a commit is started, staged changes will be automatically formatted.
To run the formatter without initiating a commit run `pre-commit`.

## Gazebo Simulation

<details>
<summary>Gazebo Installation & Resources</summary>
<br>

Install Gazebo Fortress by running: `sudo apt-get install ros-humble-ros-gz`

More info [here](https://gazebosim.org/docs/garden/ros_installation). Remember that we are using ROS 2 Humble.
Expand All @@ -169,7 +176,7 @@ Information about ROS types -> gazebo types can be found [here](https://github.c
<details>
<summary>Running the Gazebo Simulation</summary>
<br>

To run the Gazebo simulation:
```
colcon build --symlink-install --packages-up-to ros_gz_launch
Expand Down Expand Up @@ -255,7 +262,7 @@ sudo grep -a 'mycmd' /var/log/syslog
<details>
<summary>Gstreamer Server/Client Instructions</summary>
<br>
To start gstreamer client make sure to add the deepstream layer to the docker layers
To start gstreamer client make sure to add the deepstream layer to the docker layers

To start the gstreamer client run the following commands:

Expand Down
8 changes: 8 additions & 0 deletions ruff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# exclude all of the sub modules
exclude = [
"src/zed-ros2-wrapper",
"src/isaac_ros/isaac_ros_apriltag",
"src/isaac_ros/isaac_ros_image_pipeline",
"src/isaac_ros/isaac_ros_nitros",
"src/isaac_ros/isaac_ros_visual_slam",
]
Loading