Overview

First, thanks for taking the time to contribute! I hope my work will be of high quality and useful to others, but I realize there’s always room for improvement, and I’m very glad you’re willing to help.

• Ways To Contribute
  • Reporting Bugs
  • Suggesting Enhancements
  • Creating a Pull Request
• Project Setup
  • Set up the Tooling
  • Tooling for Testing
  • Tooling for Documentation
  • Commits, Versioning and ChangeLog
  • Helpful Dev and Debug Tools
    • Interactive Test Server
    • Interactive Shell
• Modifying The Code
  • Repository Organization
  • Code Style
  • Classes
  • Adding new ZohoObject Classes
    • Examine the API Request and Response
    • Add the class
  • Extending ZohoObject Classes
    • Examine the API Docs
    • Create a Mixin Class
    • Create Internal Method(s)
    • Ensure the Operation is Valid
    • Perform the API Call
    • Create Public Method(s)
  • Adding a New API Object
    • Create a Module for the API
    • Define the Class
    • Set the OAuth Scope
    • (Optional) Determine Available Regions
    • Write get_endpoint()
    • Expose Available ZohoObjects
    • Expose the module
• Code of Conduct
  • Our Pledge
  • Our Standards
  • Enforcement Responsibilities
  • Scope
  • Enforcement
  • Enforcement Guidelines
    • 1. Correction
    • 2. Warning
    • 3. Temporary Ban
    • 4. Permanent Ban
  • Attribution
• Hacking the Internals
  • pyzohoapi.core
    • ZohoAPIBase
    • ZohoObjectBase
  • pyzohoapi.core.collection
  • pyzohoapi.core.utils
  • pyzohoapi.exceptions
  • pyzohoapi.objecttypes
  • pyzohoapi.objecttypes.mixins