Development

• Getting started
  • Source code
  • Coding style
  • Pre-commit plugin
  • Build documentation locally
• Testing
  • Automated tests
  • Replay Data
  • Reusing other tests’ replay data
  • Updating assertions
• Github OpenAPI
  • Adding classes, attributes and methods
  • OpenAPI annotations
  • The OpenAPI sync CLI
  • Setup OpenAPI support
  • Automatically add schemas to PyGithub classes
  • Automatically add attributes to PyGithub classes
  • Create a PyGithub class from an OpenAPI schema
  • Create a PyGithub method from an OpenAPI path
• Github GraphQL
  • GraphQL Classes
  • Query
  • Mutation
  • Pagination

Deprecation warning

Before removing attributes/methods, consider adding deprecation warnings instead. The typing_extensions package provides a handy decorator to add deprecation warnings.

from typing_extensions import deprecated

@property
@deprecated("Use core instead")
def rate(self):
   pass

@deprecated("Deprecated in favor of the new branch protection")
def get_protected_branch(self):
   pass