# System Compatibility Checker
[](https://python.org)
[](https://opensource.org/licenses/MIT)
[](https://github.com/yourusername/system-compat-checker)
A powerful cross-platform CLI tool for checking system compatibility with various applications. This tool collects detailed system information and uses AI-powered analysis to determine if your system meets the requirements for specific software.
## ✨ Features
- 🖥️ **Cross-platform support** - Works on Windows, Linux, and macOS
- 📊 **Comprehensive system analysis** - CPU, memory, storage, GPU, and performance metrics
- 🤖 **AI-powered compatibility analysis** - Uses Groq API for intelligent assessments
- 🎨 **Rich terminal interface** - Beautiful, colorized output with tables and panels
- 🔒 **Secure credential management** - Safe API key storage using system keyring
- 📄 **Multiple output formats** - Console tables, JSON, and file output
- ⚡ **Fast performance** - Quick system information collection
## 🚀 Quick Start
### Installation
```bash
pip install system-compat-checker
```
### Verify Installation
```bash
# Check if installation is working
python -m system_compat_checker install-check
# If syscheck command works:
syscheck --help
# If not, use module syntax (always works):
python -m system_compat_checker --help
```
### Setup (First Time)
```bash
# Get a free API key at console.groq.com first
# Method 1: Direct command (if syscheck works)
syscheck setup YOUR_API_KEY
# Method 2: Module syntax (always works)
python -m system_compat_checker setup YOUR_API_KEY
```
### Check Your System
```bash
# View system information
syscheck system-info
# Check compatibility with an application
syscheck check "Adobe Photoshop"
```
## 📖 Usage
### Commands
| Command | Description | Example |
|---------|-------------|---------|
| `syscheck version` | Show version information | `syscheck version` |
| `syscheck setup` | Configure Groq API key | `syscheck setup --force` |
| `syscheck system-info` | Display system information | `syscheck system-info --json` |
| `syscheck check` | Check application compatibility | `syscheck check "Blender" -r req.json` |
| `syscheck reset` | Remove stored API key | `syscheck reset` |
### System Information
```bash
# Formatted table output
syscheck system-info
# JSON output for scripting
syscheck system-info --json > my_system.json
```
### Compatibility Analysis
```bash
# Basic compatibility check
syscheck check "Visual Studio Code"
# With custom requirements file
syscheck check "My Game" --requirements game_requirements.json
# Save results to file
syscheck check "Photoshop" --output compatibility_report.json
```
### Requirements File Format
Create custom application requirements using JSON:
```json
{
"application": "My Application",
"requirements": {
"cpu": {
"cores": 4,
"frequency": 2.5
},
"memory": {
"ram": 8
},
"storage": {
"free": 10
},
"gpu": {
"required": true,
"memory": 4
}
}
}
```
## 🛠️ Development
### From Source
```bash
# Clone the repository
git clone https://github.com/yourusername/system-compat-checker.git
cd system-compat-checker
# Create virtual environment
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
# Install in development mode
pip install -e .
# Run tests
pytest
```
### Project Structure
```
system-compat-checker/
├── src/ # Source code
│ ├── cli.py # CLI interface
│ ├── system_info.py # System information collection
│ ├── groq_analyzer.py # AI compatibility analysis
│ ├── storage.py # Secure API key storage
│ ├── windows_info.py # Windows-specific collectors
│ └── posix_info.py # Linux/macOS collectors
├── tests/ # Unit tests
├── docs/ # Documentation
└── examples/ # Example files
```
## 📚 Documentation
- **[User Guide](docs/USER_GUIDE.md)** - Comprehensive usage documentation
- **[Project Documentation](docs/PROJECT_DOCUMENTATION.md)** - Technical architecture details
- **[Contributing Guide](CONTRIBUTING.md)** - Development guidelines
## 🔧 System Requirements
- Python 3.8 or higher
- Internet connection (for AI analysis)
- Groq API key (free at [console.groq.com](https://console.groq.com/))
## 🤝 Contributing
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on:
- Code style and standards
- Testing requirements
- Pull request process
- Development setup
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🆘 Support
- **Documentation**: Check the [User Guide](docs/USER_GUIDE.md) for detailed instructions
- **Issues**: Report bugs on [GitHub Issues](https://github.com/yourusername/system-compat-checker/issues)
- **Discussions**: Join conversations in [GitHub Discussions](https://github.com/yourusername/system-compat-checker/discussions)
## 🏆 Acknowledgments
- Built with [Click](https://click.palletsprojects.com/) for CLI interface
- Powered by [Groq](https://groq.com/) for AI analysis
- Uses [Rich](https://rich.readthedocs.io/) for beautiful terminal output
- System information via [psutil](https://psutil.readthedocs.io/)
---
Made with ❤️ by the System Compatibility Checker Team
Raw data
{
"_id": null,
"home_page": "https://github.com/yourusername/system-compat-checker",
"name": "system-compat-checker",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "System Compatibility Checker Team <contact@system-compat-checker.dev>",
"keywords": "system, compatibility, checker, hardware, requirements, analysis, CLI",
"author": "System Compatibility Checker Team",
"author_email": "System Compatibility Checker Team <contact@system-compat-checker.dev>",
"download_url": "https://files.pythonhosted.org/packages/f0/99/a5c5ba3511188ec55d204717dc037b8e80ba86a50d16d3656cde5c83c476/system_compat_checker-1.0.2.tar.gz",
"platform": null,
"description": "# System Compatibility Checker\r\n\r\n[](https://python.org)\r\n[](https://opensource.org/licenses/MIT)\r\n[](https://github.com/yourusername/system-compat-checker)\r\n\r\nA powerful cross-platform CLI tool for checking system compatibility with various applications. This tool collects detailed system information and uses AI-powered analysis to determine if your system meets the requirements for specific software.\r\n\r\n## \u2728 Features\r\n\r\n- \ud83d\udda5\ufe0f **Cross-platform support** - Works on Windows, Linux, and macOS\r\n- \ud83d\udcca **Comprehensive system analysis** - CPU, memory, storage, GPU, and performance metrics\r\n- \ud83e\udd16 **AI-powered compatibility analysis** - Uses Groq API for intelligent assessments\r\n- \ud83c\udfa8 **Rich terminal interface** - Beautiful, colorized output with tables and panels\r\n- \ud83d\udd12 **Secure credential management** - Safe API key storage using system keyring\r\n- \ud83d\udcc4 **Multiple output formats** - Console tables, JSON, and file output\r\n- \u26a1 **Fast performance** - Quick system information collection\r\n\r\n## \ud83d\ude80 Quick Start\r\n\r\n### Installation\r\n\r\n```bash\r\npip install system-compat-checker\r\n```\r\n\r\n### Verify Installation\r\n\r\n```bash\r\n# Check if installation is working\r\npython -m system_compat_checker install-check\r\n\r\n# If syscheck command works:\r\nsyscheck --help\r\n\r\n# If not, use module syntax (always works):\r\npython -m system_compat_checker --help\r\n```\r\n\r\n### Setup (First Time)\r\n\r\n```bash\r\n# Get a free API key at console.groq.com first\r\n\r\n# Method 1: Direct command (if syscheck works)\r\nsyscheck setup YOUR_API_KEY\r\n\r\n# Method 2: Module syntax (always works)\r\npython -m system_compat_checker setup YOUR_API_KEY\r\n```\r\n\r\n### Check Your System\r\n\r\n```bash\r\n# View system information\r\nsyscheck system-info\r\n\r\n# Check compatibility with an application\r\nsyscheck check \"Adobe Photoshop\"\r\n```\r\n\r\n## \ud83d\udcd6 Usage\r\n\r\n### Commands\r\n\r\n| Command | Description | Example |\r\n|---------|-------------|---------|\r\n| `syscheck version` | Show version information | `syscheck version` |\r\n| `syscheck setup` | Configure Groq API key | `syscheck setup --force` |\r\n| `syscheck system-info` | Display system information | `syscheck system-info --json` |\r\n| `syscheck check` | Check application compatibility | `syscheck check \"Blender\" -r req.json` |\r\n| `syscheck reset` | Remove stored API key | `syscheck reset` |\r\n\r\n### System Information\r\n\r\n```bash\r\n# Formatted table output\r\nsyscheck system-info\r\n\r\n# JSON output for scripting\r\nsyscheck system-info --json > my_system.json\r\n```\r\n\r\n### Compatibility Analysis\r\n\r\n```bash\r\n# Basic compatibility check\r\nsyscheck check \"Visual Studio Code\"\r\n\r\n# With custom requirements file\r\nsyscheck check \"My Game\" --requirements game_requirements.json\r\n\r\n# Save results to file\r\nsyscheck check \"Photoshop\" --output compatibility_report.json\r\n```\r\n\r\n### Requirements File Format\r\n\r\nCreate custom application requirements using JSON:\r\n\r\n```json\r\n{\r\n \"application\": \"My Application\",\r\n \"requirements\": {\r\n \"cpu\": {\r\n \"cores\": 4,\r\n \"frequency\": 2.5\r\n },\r\n \"memory\": {\r\n \"ram\": 8\r\n },\r\n \"storage\": {\r\n \"free\": 10\r\n },\r\n \"gpu\": {\r\n \"required\": true,\r\n \"memory\": 4\r\n }\r\n }\r\n}\r\n```\r\n\r\n## \ud83d\udee0\ufe0f Development\r\n\r\n### From Source\r\n\r\n```bash\r\n# Clone the repository\r\ngit clone https://github.com/yourusername/system-compat-checker.git\r\ncd system-compat-checker\r\n\r\n# Create virtual environment\r\npython -m venv .venv\r\nsource .venv/bin/activate # Windows: .venv\\Scripts\\activate\r\n\r\n# Install in development mode\r\npip install -e .\r\n\r\n# Run tests\r\npytest\r\n```\r\n\r\n### Project Structure\r\n\r\n```\r\nsystem-compat-checker/\r\n\u251c\u2500\u2500 src/ # Source code\r\n\u2502 \u251c\u2500\u2500 cli.py # CLI interface\r\n\u2502 \u251c\u2500\u2500 system_info.py # System information collection\r\n\u2502 \u251c\u2500\u2500 groq_analyzer.py # AI compatibility analysis\r\n\u2502 \u251c\u2500\u2500 storage.py # Secure API key storage\r\n\u2502 \u251c\u2500\u2500 windows_info.py # Windows-specific collectors\r\n\u2502 \u2514\u2500\u2500 posix_info.py # Linux/macOS collectors\r\n\u251c\u2500\u2500 tests/ # Unit tests\r\n\u251c\u2500\u2500 docs/ # Documentation\r\n\u2514\u2500\u2500 examples/ # Example files\r\n```\r\n\r\n## \ud83d\udcda Documentation\r\n\r\n- **[User Guide](docs/USER_GUIDE.md)** - Comprehensive usage documentation\r\n- **[Project Documentation](docs/PROJECT_DOCUMENTATION.md)** - Technical architecture details\r\n- **[Contributing Guide](CONTRIBUTING.md)** - Development guidelines\r\n\r\n## \ud83d\udd27 System Requirements\r\n\r\n- Python 3.8 or higher\r\n- Internet connection (for AI analysis)\r\n- Groq API key (free at [console.groq.com](https://console.groq.com/))\r\n\r\n## \ud83e\udd1d Contributing\r\n\r\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on:\r\n\r\n- Code style and standards\r\n- Testing requirements\r\n- Pull request process\r\n- Development setup\r\n\r\n## \ud83d\udcc4 License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## \ud83c\udd98 Support\r\n\r\n- **Documentation**: Check the [User Guide](docs/USER_GUIDE.md) for detailed instructions\r\n- **Issues**: Report bugs on [GitHub Issues](https://github.com/yourusername/system-compat-checker/issues)\r\n- **Discussions**: Join conversations in [GitHub Discussions](https://github.com/yourusername/system-compat-checker/discussions)\r\n\r\n## \ud83c\udfc6 Acknowledgments\r\n\r\n- Built with [Click](https://click.palletsprojects.com/) for CLI interface\r\n- Powered by [Groq](https://groq.com/) for AI analysis\r\n- Uses [Rich](https://rich.readthedocs.io/) for beautiful terminal output\r\n- System information via [psutil](https://psutil.readthedocs.io/)\r\n\r\n---\r\n\r\nMade with \u2764\ufe0f by the System Compatibility Checker Team\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A cross-platform CLI tool for checking system compatibility with AI-powered analysis",
"version": "1.0.2",
"project_urls": {
"Bug Reports": "https://github.com/yourusername/system-compat-checker/issues",
"Documentation": "https://github.com/yourusername/system-compat-checker/tree/main/docs",
"Homepage": "https://github.com/yourusername/system-compat-checker",
"Repository": "https://github.com/yourusername/system-compat-checker"
},
"split_keywords": [
"system",
" compatibility",
" checker",
" hardware",
" requirements",
" analysis",
" cli"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7a0a6a785dafea182ef0b75ac6964d5831df5dfaab9a14c14c60eebbf6cc4618",
"md5": "e344552ac0a1f8a3d65abc18e7e8ffe4",
"sha256": "2baba1833ccb8728bcd40e20dc5d22fccb9085f40edbdaf53d899abe1d22f4b2"
},
"downloads": -1,
"filename": "system_compat_checker-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e344552ac0a1f8a3d65abc18e7e8ffe4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 20947,
"upload_time": "2025-08-30T12:33:11",
"upload_time_iso_8601": "2025-08-30T12:33:11.655695Z",
"url": "https://files.pythonhosted.org/packages/7a/0a/6a785dafea182ef0b75ac6964d5831df5dfaab9a14c14c60eebbf6cc4618/system_compat_checker-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f099a5c5ba3511188ec55d204717dc037b8e80ba86a50d16d3656cde5c83c476",
"md5": "6ccbf655091efe65e09b0c292c87c266",
"sha256": "a1bc8cc2add8eba756ef3015c43dd6257f80ac7b06bdcc3c7208dda06edeffe4"
},
"downloads": -1,
"filename": "system_compat_checker-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "6ccbf655091efe65e09b0c292c87c266",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 43455,
"upload_time": "2025-08-30T12:33:13",
"upload_time_iso_8601": "2025-08-30T12:33:13.687812Z",
"url": "https://files.pythonhosted.org/packages/f0/99/a5c5ba3511188ec55d204717dc037b8e80ba86a50d16d3656cde5c83c476/system_compat_checker-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-30 12:33:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yourusername",
"github_project": "system-compat-checker",
"github_not_found": true,
"lcname": "system-compat-checker"
}
JSON
