Python Github Setup

1{
2    "general": {
3        "coding_style": {
4            "language": "Python",
5            "use_strict": true,
6            "indentation": "4 spaces",
7            "max_line_length": 120,
8            "comments": {
9                "style": "# for single-line, ''' for multi-line",
10                "require_comments": true
11            }
12        },
13        
14        "naming_conventions": {
15            "variables": "snake_case",
16            "functions": "snake_case",
17            "classes": "PascalCase",
18            "interfaces": "PascalCase",
19            "files": "snake_case"
20        },
21        
22        "error_handling": {
23            "prefer_try_catch": true,
24            "log_errors": true
25        },
26        
27        "testing": {
28            "require_tests": true,
29            "test_coverage": "80%",
30            "test_types": ["unit", "integration"]
31        },
32        
33        "documentation": {
34            "require_docs": true,
35            "doc_tool": "docstrings",
36            "style_guide": "Google Python Style Guide"
37        },
38        
39        "security": {
40            "require_https": true,
41            "sanitize_inputs": true,
42            "validate_inputs": true,
43            "use_env_vars": true
44        },
45        
46        "configuration_management": {
47            "config_files": [".env"],
48            "env_management": "python-dotenv",
49            "secrets_management": "environment variables"
50        },
51        
52        "code_review": {
53            "require_reviews": true,
54            "review_tool": "GitHub Pull Requests",
55            "review_criteria": ["functionality", "code quality", "security"]
56        },
57        
58        "version_control": {
59            "system": "Git",
60            "branching_strategy": "GitHub Flow",
61            "commit_message_format": "Conventional Commits"
62        },
63        
64        "logging": {
65            "logging_tool": "Python logging module",
66            "log_levels": ["debug", "info", "warn", "error"],
67            "log_retention_policy": "7 days"
68        },
69        
70        "monitoring": {
71            "monitoring_tool": "Not specified",
72            "metrics": ["file processing time", "classification accuracy", "error rate"]
73        },
74        
75        "dependency_management": {
76            "package_manager": "pip",
77            "versioning_strategy": "Semantic Versioning"
78        },
79        
80        "accessibility": {
81            "standards": ["Not applicable"],
82            "testing_tools": ["Not applicable"]
83        },
84        
85        "internationalization": {
86            "i18n_tool": "Not applicable",
87            "supported_languages": ["English"],
88            "default_language": "English"
89        },
90        
91        "ci_cd": {
92            "ci_tool": "GitHub Actions",
93            "cd_tool": "Not specified",
94            "pipeline_configuration": ".github/workflows/main.yml"
95        },
96        
97        "code_formatting": {
98            "formatter": "Black",
99            "linting_tool": "Pylint",
100            "rules": ["PEP 8", "project-specific rules"]
101        },
102        
103        "architecture": {
104            "patterns": ["Modular design"],
105            "principles": ["Single Responsibility", "DRY"]
106        }
107    },
108    
109    "project_specific": {
110        "use_framework": "None",
111        "styling": "Not applicable",
112        "testing_framework": "pytest",
113        "build_tool": "setuptools",
114        
115        "deployment": {
116            "environment": "Local machine",
117            "automation": "Not specified",
118            "strategy": "Manual deployment"
119        },
120        
121        "performance": {
122            "benchmarking_tool": "Not specified",
123            "performance_goals": {
124                "response_time": "< 5 seconds per file",
125                "throughput": "Not specified",
126                "error_rate": "< 1%"
127            }
128        }
129    },
130    
131    "context": {
132        "codebase_overview": "Python-based file organization tool using AI for content analysis and classification",
133        "libraries": [
134            "watchdog", "spacy", "PyPDF2", "python-docx", "pandas", "beautifulsoup4", 
135            "transformers", "scikit-learn", "joblib", "python-dotenv", "torch", "pytest", 
136            "shutil", "logging", "pytest-mock"
137        ],
138        
139        "coding_practices": {
140            "modularity": true,
141            "DRY_principle": true,
142            "performance_optimization": true
143        }
144    },
145    
146    "behavior": {
147        "verbosity": {
148            "level": 2,
149            "range": [0, 3]
150        },
151        "handle_incomplete_tasks": "Provide partial solution and explain limitations",
152        "ask_for_clarification": true,
153        "communication_tone": "Professional and concise"
154    }
155}
156 
157