CODE_README.md

Schema.org Code

This document contains recommendations for the code of the schema.org project.

Python

We recommend following the Google Python Style Guide. We recommend the following:

• Use PEP-484 style type definition for functions.
• Use context managers for file operations and locking.
• Keep the code as platform agnostic as possible, use the relevant Python functionalities for system, terminal interactions.
• Use the logging package for all logging output (no prints).
• Use ruff for linting and formatting.
• When possible, use the default Python packages, be mindful when adding new dependencies.