Standardize robot.py styling for copyright header (#93)

Author: fletch3555

.github/workflows/test.yml

@@ -16,6 +16,17 @@ jobs:
     - uses: actions/checkout@v4
     - uses: psf/black@stable
 
+  check-file-headers:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v4
+      with:
+        python-version: 3.12
+    - name: Check header
+      run: python ./check_header.py
+      shell: bash
+
   test:
     runs-on: ${{ matrix.os }}
     strategy:

addressableled/robot.py

@@ -1,3 +1,10 @@
+#!/usr/bin/env python3
+#
+# Copyright (c) FIRST and other WPILib contributors.
+# Open Source Software; you can modify and/or share it under the terms of
+# the WPILib BSD license file in the root directory of this project.
+#
+
 import wpilib
 
 kLEDBuffer = 60

arcade-drive-xbox-controller/robot.py

@@ -1,14 +1,20 @@
 #!/usr/bin/env python3
-"""
-    This is a demo program showing the use of the DifferentialDrive class.
-    Runs the motors with split arcade steering and an Xbox controller.
-"""
+#
+# Copyright (c) FIRST and other WPILib contributors.
+# Open Source Software; you can modify and/or share it under the terms of
+# the WPILib BSD license file in the root directory of this project.
+#
 
 import wpilib
 import wpilib.drive
 
 
 class MyRobot(wpilib.TimedRobot):
+    """
+    This is a demo program showing the use of the DifferentialDrive class.
+    Runs the motors with split arcade steering and an Xbox controller.
+    """
+
     def robotInit(self):
         """Robot initialization function"""
 

arcade-drive/robot.py

@@ -1,14 +1,20 @@
 #!/usr/bin/env python3
-"""
-    This is a demo program showing the use of the DifferentialDrive class.
-    Runs the motors with arcade steering.
-"""
+#
+# Copyright (c) FIRST and other WPILib contributors.
+# Open Source Software; you can modify and/or share it under the terms of
+# the WPILib BSD license file in the root directory of this project.
+#
 
 import wpilib
 import wpilib.drive
 
 
 class MyRobot(wpilib.TimedRobot):
+    """
+    This is a demo program showing the use of the DifferentialDrive class.
+    Runs the motors with arcade steering.
+    """
+
     def robotInit(self):
         """Robot initialization function"""
 

arm-simulation/constants.py

@@ -1,6 +1,8 @@
+#
 # Copyright (c) FIRST and other WPILib contributors.
 # Open Source Software; you can modify and/or share it under the terms of
 # the WPILib BSD license file in the root directory of this project.
+#
 
 import math
 

arm-simulation/physics.py

@@ -1,3 +1,9 @@
+#
+# Copyright (c) FIRST and other WPILib contributors.
+# Open Source Software; you can modify and/or share it under the terms of
+# the WPILib BSD license file in the root directory of this project.
+#
+
 #
 # See the documentation for more details on how this works
 #

arm-simulation/robot.py

@@ -3,6 +3,7 @@
 # Copyright (c) FIRST and other WPILib contributors.
 # Open Source Software; you can modify and/or share it under the terms of
 # the WPILib BSD license file in the root directory of this project.
+#
 
 import wpilib
 

arm-simulation/subsytems/arm.py

@@ -1,6 +1,8 @@
+#
 # Copyright (c) FIRST and other WPILib contributors.
 # Open Source Software; you can modify and/or share it under the terms of
 # the WPILib BSD license file in the root directory of this project.
+#
 
 import wpilib
 

armbot/constants.py

@@ -1,6 +1,8 @@
+#
 # Copyright (c) FIRST and other WPILib contributors.
 # Open Source Software; you can modify and/or share it under the terms of
 # the WPILib BSD license file in the root directory of this project.
+#
 
 """
 The constants module is a convenience place for teams to hold robot-wide

armbot/robot.py

@@ -1,8 +1,9 @@
-#!usr/bin/env python3
-
+#!/usr/bin/env python3
+#
 # Copyright (c) FIRST and other WPILib contributors.
 # Open Source Software; you can modify and/or share it under the terms of
 # the WPILib BSD license file in the root directory of this project.
+#
 
 import wpilib
 import commands2