Developer Guide

Note

The Developer Guide does not contain any documentation about using pyATS Clean. It it highly recommended to read the User Guide before continuing.

This topic provides an overview required to contribute to pyATS Clean.

The Developer Guide includes the following topics and subtopics:

• Creating New Clean Stages
  • Determine what OS and Platform the new Clean Stage is designed for
  • Create a new python function inside the correct stages.py file
  • Adding stage arguments and schema
  • Add a docstring to the Clean Stage
  • Adding the python code the stage requires
  • Testing the new Stage
  • Contributing the new Stage into the repository