Name: python
Author: cmlccie

Instruction file imported from cmlccie/agentic (.github/instructions/python.instructions.md). Copyright stays with the author.

Use functional programming principles.
Prefer function-based code organization over class-based code organization.
Use consistent naming conventions for variables, functions, and modules.
Include detailed docstrings for all modules, classes, and functions.
Follow PEP 8 style guidelines for Python code.
Use type hints for function signatures.
Write modular and reusable code.
Include error handling and input validation, with clear and friendly error messages appropriate for beginners in an educational context.
Include logging for important events and errors, using Python's built-in logging module.
Use click.echo for printing to the console in CLI applications.
CLI applications should have a clear and user-friendly interface, with help messages and documentation for each command and option.
All CLI outputs should be well-formatted and easy to read.

{ "ocm": "1", "id": "cmlccie-agentic-python-instructions", "kind": "skill", "name": "python", "description": "Use functional programming principles. - Prefer function-based code organization over class-based code organization. - Use consistent naming conventions for variables, functions, and modules. - Include detailed docstrings for all modules, classes, and functions. - Follow PEP 8 style guidelines for Python code. - Use type hints for function signatures. - Write modular and reusable code. - Include error handling and input validation, with clear and friendly error messages appropriate for beginners in an educational context. - Include logging for important events and errors, using Python's built-in `logging` module. - Use `click.echo` for printing to the console in CLI applications. - CLI applications should have a clear and user-friendly interface, with help messages and documentation for each command and option. - All CLI outputs should be well-formatted and easy to read.", "publisher": "cmlccie", "version": "1.0.0", "capabilities": { "domains": [ "coding" ], "tags": [ "skill-md", "github-instructions" ], "languages": [ "en" ] }, "quality_prior": 0.6, "examples": [ "Use functional programming principles. - Prefer function-based code organization over class-based code organization. - Use consistent naming conventions for variables, functions, and modules. - Include detailed docstrings for all modules, classes, and functions. - Follow PEP 8 style guidelines for Python code. - Use type hints for function signatures. - Write modular and reusable code. - Include error handling and input validation, with clear and friendly error messages appropriate for beginners in an educational context. - Include logging for important events and errors, using Python's built-in `logging` module. - Use `click.echo` for printing to the console in CLI applications. - CLI applications should have a clear and user-friendly interface, with help messages and documentation for each command and option. - All CLI outputs should be well-formatted and easy to read." ], "primary": false, "metadata": { "source": { "provider": "github-instructions", "repository": "https://github.com/cmlccie/agentic", "path": ".github/instructions/python.instructions.md", "ref": "8374328ed0d31498be1533aee21a821c89aa8894", "url": "https://github.com/cmlccie/agentic/blob/8374328ed0d31498be1533aee21a821c89aa8894/.github/instructions/python.instructions.md", "key": "cmlccie/agentic/.github/instructions/python.instructions.md" }, "applies_to": "**/*.py" }, "instructions": "- Use functional programming principles.\n- Prefer function-based code organization over class-based code organization.\n- Use consistent naming conventions for variables, functions, and modules.\n- Include detailed docstrings for all modules, classes, and functions.\n- Follow PEP 8 style guidelines for Python code.\n- Use type hints for function signatures.\n- Write modular and reusable code.\n- Include error handling and input validation, with clear and friendly error messages appropriate for beginners in an educational context.\n- Include logging for important events and errors, using Python's buil", "cost": { "context_tokens": 221 } }

python

About

Use it

Manifest

Reviews