Generic Context for OCI/Python Applications

This file provides universal guidelines, standards, and best practices for developing maintainable, consistent, and high-quality “OCI App” or Python analytical applications. It acts as a reusable template and reference for entirely new projects or subprojects based on this repository’s technology stack.

What is Included Here?

Coding standards: How to write idiomatic, clean Python
Organization: Folder structure, UI/logic separation, modularity
Quality automation: How to use tools like Ruff, pre-commit, and enforce semantic versioning
Change management: Recommendations for changelog strategies and release workflow
Contribution workflow: Steps to safely contribute new features (PR requirements, checklist)

How to Use

Use this as the first stop when bootstrapping any new project or feature, even before reviewing project-specific overrides in ../project/.
When generic guidance conflicts with a specific project’s context, project rules win. Otherwise, follow these practices.

Extending and Evolving

When a new best practice emerges, update this file!
Fork this as the seed for new “OCI App” projects or for bootstrapping generic solutions using the stack developed in this repository.