pyATS Development Guide

This guide describes how you can use the features and functionality of pyATS and the pyATS Library to meet your specific network test automation requirements. Designed for both programmers and network engineers, this guide will help you to tailor the reusable pyATS Library tests to meet your specific requirements.

Note

This guide does not describe the details of how to use Python, but you can find many excellent Python tutorials online.

Write a script

• Everything is Python
• Write a Python script
  • Why write a script?
  • Write a basic script
  • Write an advanced script

Contribute to pyATS

• Write a parser
  • 1. What is a parser?
  • 2. Why write a parser?
  • 3. How the pyATS Library parsers work
  • 4. Setting up your development environment
  • 5. Writing the Schema Class
  • 6. Writing the Parser Class
  • 7. Testing your parser
  • 8. Revising a parser
  • 9. Versioning a Parser
  • 10. Contributing your work to the pyATS project
• Write an API
  • Configure
  • Get
  • Verify
  • Revision
  • Unit Testing
• Write a trigger
  • Triggers, verifications, and test cases
  • Example of a trigger file
  • Write your own trigger
  • Example of a trigger with verifications
• pyATS Blitz
• Contribution guidelines
  • Helping with documentation issues
  • Help proofreading documentation
  • Helping with source code
  • Check the existing components
  • Clone the source code repository
  • Write new code
  • Run unit tests
  • Update the changelog
  • Making good commits
  • Commit your changes
  • Making good pull request
  • Open a pull request

Resources

• Glossary