pycrosscheck 1.0.0__tar.gz

pycrosscheck-1.0.0/LICENSE

@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2026, Software Analysis and Testing (SWAT) Research Group at NCSU
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pycrosscheck-1.0.0/MANIFEST.in

@@ -0,0 +1,20 @@
+# Include documentation
+include README.md
+include LICENSE
+include requirements.txt
+
+# Include all Python packages
+recursive-include compatibility_rules *.py
+recursive-include my_bandit_plugin *.py
+recursive-include platform_compatibility *.py
+
+# Exclude unnecessary files
+global-exclude *.pyc
+global-exclude __pycache__
+global-exclude *.so
+global-exclude .DS_Store
+exclude .gitignore
+recursive-exclude tests *
+recursive-exclude env *
+recursive-exclude real_cases *
+recursive-exclude ruff_fixer *

pycrosscheck-1.0.0/PKG-INFO

@@ -0,0 +1,333 @@
+Metadata-Version: 2.4
+Name: pycrosscheck
+Version: 1.0.0
+Summary: A cross-platform compatibility checker for Python code - detects Windows/Linux/macOS incompatibilities
+Author: Platform Compatibility Team
+Author-email: Denini Gabriel <denini.gabriel@gmail.com>
+Maintainer-email: Denini Gabriel <denini.gabriel@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/denini08/pycrosscheck
+Project-URL: Bug Reports, https://github.com/denini08/pycrosscheck/issues
+Project-URL: Source, https://github.com/denini08/pycrosscheck
+Project-URL: Documentation, https://github.com/denini08/pycrosscheck#readme
+Keywords: compatibility,cross-platform,windows,linux,macos,static-analysis,linting,code-quality
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: bandit>=1.7.0
+Requires-Dist: astor>=0.8.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Dynamic: author
+Dynamic: license-file
+Dynamic: requires-python
+
+# PyCrossCheck
+
+🔍 **A cross-platform compatibility checker for Python code**
+
+PyCrossCheck automatically detects platform-specific code that may cause issues on Windows, Linux, or macOS, and provides intelligent suggestions for cross-platform alternatives.
+
+## 🚀 Features
+
+- **Cross-Platform Detection**: Identifies Windows, Linux, and macOS-specific code that may break on other platforms
+- **Smart Suggestions**: Provides clear, actionable recommendations with cross-platform alternatives
+- **Comprehensive Analysis**: 56+ rules organized in 10 categories covering file system, process management, user operations, and more
+- **Easy Integration**: Simple CLI interface and JSON output for CI/CD pipelines
+- **Bandit Plugin**: Extends Bandit static analysis with platform compatibility checks
+
+## 📦 Installation
+
+### From PyPI (Recommended)
+
+```bash
+pip install pycrosscheck
+```
+
+### From Source
+
+```bash
+# Clone the repository
+git clone https://github.com/yourusername/pycrosscheck.git
+cd pycrosscheck
+
+# Install in development mode
+pip install -e .
+```
+
+## 🛠️ Quick Start
+
+### Basic Usage
+
+After installation, you can use the `pycrosscheck` or `pycc` command:
+
+```bash
+# Check a single file
+pycrosscheck detect myfile.py
+
+# Check an entire project recursively
+pycrosscheck detect -r myproject/
+
+# Check with different output formats
+pycrosscheck detect --format json myfile.py
+pycrosscheck detect --format csv myfile.py
+```
+
+### View All Rules
+
+```bash
+# Display all available compatibility rules
+pycrosscheck rules
+```
+
+## 📖 Usage Examples
+
+### Example 1: Check a Python File
+
+```bash
+pycrosscheck detect script.py
+```
+
+**Sample output:**
+
+```
+🔍 Detecting Windows compatibility issues...
+💡 This tool will provide suggestions for cross-platform alternatives.
+
+Test results:
+>> Issue: [PTB001:os_windows_incompatible_functions] Windows-incompatible function: os.getuid()
+   Severity: Medium   Confidence: High
+   Location: script.py:15
+   More Info: https://bandit.readthedocs.io/en/latest/
+   💡 Suggestion: Replace with getpass.getuser() - Works on Windows, Linux, and macOS.
+```
+
+### Example 2: Check Entire Project
+
+```bash
+pycc detect -r ./myproject
+```
+
+### Example 3: CI/CD Integration
+
+```bash
+# Generate JSON report for automated processing
+pycrosscheck detect -r . --format json > compatibility_report.json
+```
+
+### Example 4: Using with Bandit Directly
+
+Since PyCrossCheck is a Bandit plugin, you can also use it with Bandit:
+
+```bash
+bandit -r myproject/ -t PTB001
+```
+
+## 📋 Compatibility Rules Categories
+
+PyCrossCheck includes 56+ rules organized into 10 categories:
+
+| Category | Description                 | Rules    |
+| -------- | --------------------------- | -------- |
+| **02**   | Process Management          | 14 rules |
+| **03**   | User and Group Management   | 11 rules |
+| **04**   | File System Operations      | 11 rules |
+| **05**   | Signal Handling             | 5 rules  |
+| **06**   | Inter-Process Communication | 3 rules  |
+| **07**   | System Information          | 4 rules  |
+| **08**   | Terminal Control            | 1 rule   |
+| **09**   | Device-Specific Operations  | 4 rules  |
+| **10**   | Priority and Scheduling     | 3 rules  |
+
+## 🔍 Examples of Detected Issues
+
+### ❌ User Management Functions
+
+**Problematic code:**
+
+```python
+import os
+
+# Will fail on Windows
+user_id = os.getuid()
+effective_user = os.geteuid()
+```
+
+**✅ PyCrossCheck suggestion:**
+
+```
+💡 Replace with getpass.getuser() - Works on Windows, Linux, and macOS.
+   Import: 'import getpass'
+```
+
+**Fixed code:**
+
+```python
+import getpass
+
+# Cross-platform solution
+username = getpass.getuser()
+```
+
+### ❌ System Information
+
+**Problematic code:**
+
+```python
+import os
+
+# Will fail on Windows
+system_info = os.uname()
+```
+
+**✅ PyCrossCheck suggestion:**
+
+```
+💡 Replace with platform.uname() for cross-platform system information.
+   Import: 'import platform'
+```
+
+**Fixed code:**
+
+```python
+import platform
+
+# Cross-platform solution
+system_info = platform.uname()
+```
+
+### ❌ Process Management
+
+**Problematic code:**
+
+```python
+import os
+
+# Will fail on Windows
+pid = os.fork()
+```
+
+**✅ PyCrossCheck suggestion:**
+
+```
+💡 Replace with multiprocessing.Process() for cross-platform process creation.
+   Import: 'from multiprocessing import Process'
+```
+
+**Fixed code:**
+
+```python
+from multiprocessing import Process
+
+def worker():
+    # Your code here
+    pass
+
+# Cross-platform solution
+process = Process(target=worker)
+process.start()
+```
+
+## 🚀 Publishing & Distribution
+
+### Prepare for PyPI Upload
+
+1. **Update version** in `pyproject.toml`
+2. **Build the package:**
+
+```bash
+pip install build twine
+python -m build
+```
+
+3. **Upload to Test PyPI (optional):**
+
+```bash
+twine upload --repository testpypi dist/*
+```
+
+4. **Upload to PyPI:**
+
+```bash
+twine upload dist/*
+```
+
+## 🛡️ CI/CD Integration
+
+### GitHub Actions Example
+
+```yaml
+name: Compatibility Check
+
+on: [push, pull_request]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+      - name: Install PyCrossCheck
+        run: pip install pycrosscheck
+      - name: Run compatibility check
+        run: pycrosscheck detect -r . --format json
+```
+
+### Pre-commit Hook
+
+Add to `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+  - repo: local
+    hooks:
+      - id: pycrosscheck
+        name: PyCrossCheck
+        entry: pycrosscheck detect
+        language: system
+        types: [python]
+```
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## 📄 License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## 🙏 Acknowledgments
+
+- Built on top of [Bandit](https://github.com/PyCQA/bandit) security analysis tool
+- Inspired by the need for better cross-platform Python code
+
+## 📞 Support
+
+- **Issues**: [GitHub Issues](https://github.com/yourusername/pycrosscheck/issues)
+- **Documentation**: [GitHub README](https://github.com/yourusername/pycrosscheck#readme)
+
+---
+
+Made with ❤️ for the Python community

pycrosscheck-1.0.0/README.md

@@ -0,0 +1,290 @@
+# PyCrossCheck
+
+🔍 **A cross-platform compatibility checker for Python code**
+
+PyCrossCheck automatically detects platform-specific code that may cause issues on Windows, Linux, or macOS, and provides intelligent suggestions for cross-platform alternatives.
+
+## 🚀 Features
+
+- **Cross-Platform Detection**: Identifies Windows, Linux, and macOS-specific code that may break on other platforms
+- **Smart Suggestions**: Provides clear, actionable recommendations with cross-platform alternatives
+- **Comprehensive Analysis**: 56+ rules organized in 10 categories covering file system, process management, user operations, and more
+- **Easy Integration**: Simple CLI interface and JSON output for CI/CD pipelines
+- **Bandit Plugin**: Extends Bandit static analysis with platform compatibility checks
+
+## 📦 Installation
+
+### From PyPI (Recommended)
+
+```bash
+pip install pycrosscheck
+```
+
+### From Source
+
+```bash
+# Clone the repository
+git clone https://github.com/yourusername/pycrosscheck.git
+cd pycrosscheck
+
+# Install in development mode
+pip install -e .
+```
+
+## 🛠️ Quick Start
+
+### Basic Usage
+
+After installation, you can use the `pycrosscheck` or `pycc` command:
+
+```bash
+# Check a single file
+pycrosscheck detect myfile.py
+
+# Check an entire project recursively
+pycrosscheck detect -r myproject/
+
+# Check with different output formats
+pycrosscheck detect --format json myfile.py
+pycrosscheck detect --format csv myfile.py
+```
+
+### View All Rules
+
+```bash
+# Display all available compatibility rules
+pycrosscheck rules
+```
+
+## 📖 Usage Examples
+
+### Example 1: Check a Python File
+
+```bash
+pycrosscheck detect script.py
+```
+
+**Sample output:**
+
+```
+🔍 Detecting Windows compatibility issues...
+💡 This tool will provide suggestions for cross-platform alternatives.
+
+Test results:
+>> Issue: [PTB001:os_windows_incompatible_functions] Windows-incompatible function: os.getuid()
+   Severity: Medium   Confidence: High
+   Location: script.py:15
+   More Info: https://bandit.readthedocs.io/en/latest/
+   💡 Suggestion: Replace with getpass.getuser() - Works on Windows, Linux, and macOS.
+```
+
+### Example 2: Check Entire Project
+
+```bash
+pycc detect -r ./myproject
+```
+
+### Example 3: CI/CD Integration
+
+```bash
+# Generate JSON report for automated processing
+pycrosscheck detect -r . --format json > compatibility_report.json
+```
+
+### Example 4: Using with Bandit Directly
+
+Since PyCrossCheck is a Bandit plugin, you can also use it with Bandit:
+
+```bash
+bandit -r myproject/ -t PTB001
+```
+
+## 📋 Compatibility Rules Categories
+
+PyCrossCheck includes 56+ rules organized into 10 categories:
+
+| Category | Description                 | Rules    |
+| -------- | --------------------------- | -------- |
+| **02**   | Process Management          | 14 rules |
+| **03**   | User and Group Management   | 11 rules |
+| **04**   | File System Operations      | 11 rules |
+| **05**   | Signal Handling             | 5 rules  |
+| **06**   | Inter-Process Communication | 3 rules  |
+| **07**   | System Information          | 4 rules  |
+| **08**   | Terminal Control            | 1 rule   |
+| **09**   | Device-Specific Operations  | 4 rules  |
+| **10**   | Priority and Scheduling     | 3 rules  |
+
+## 🔍 Examples of Detected Issues
+
+### ❌ User Management Functions
+
+**Problematic code:**
+
+```python
+import os
+
+# Will fail on Windows
+user_id = os.getuid()
+effective_user = os.geteuid()
+```
+
+**✅ PyCrossCheck suggestion:**
+
+```
+💡 Replace with getpass.getuser() - Works on Windows, Linux, and macOS.
+   Import: 'import getpass'
+```
+
+**Fixed code:**
+
+```python
+import getpass
+
+# Cross-platform solution
+username = getpass.getuser()
+```
+
+### ❌ System Information
+
+**Problematic code:**
+
+```python
+import os
+
+# Will fail on Windows
+system_info = os.uname()
+```
+
+**✅ PyCrossCheck suggestion:**
+
+```
+💡 Replace with platform.uname() for cross-platform system information.
+   Import: 'import platform'
+```
+
+**Fixed code:**
+
+```python
+import platform
+
+# Cross-platform solution
+system_info = platform.uname()
+```
+
+### ❌ Process Management
+
+**Problematic code:**
+
+```python
+import os
+
+# Will fail on Windows
+pid = os.fork()
+```
+
+**✅ PyCrossCheck suggestion:**
+
+```
+💡 Replace with multiprocessing.Process() for cross-platform process creation.
+   Import: 'from multiprocessing import Process'
+```
+
+**Fixed code:**
+
+```python
+from multiprocessing import Process
+
+def worker():
+    # Your code here
+    pass
+
+# Cross-platform solution
+process = Process(target=worker)
+process.start()
+```
+
+## 🚀 Publishing & Distribution
+
+### Prepare for PyPI Upload
+
+1. **Update version** in `pyproject.toml`
+2. **Build the package:**
+
+```bash
+pip install build twine
+python -m build
+```
+
+3. **Upload to Test PyPI (optional):**
+
+```bash
+twine upload --repository testpypi dist/*
+```
+
+4. **Upload to PyPI:**
+
+```bash
+twine upload dist/*
+```
+
+## 🛡️ CI/CD Integration
+
+### GitHub Actions Example
+
+```yaml
+name: Compatibility Check
+
+on: [push, pull_request]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+      - name: Install PyCrossCheck
+        run: pip install pycrosscheck
+      - name: Run compatibility check
+        run: pycrosscheck detect -r . --format json
+```
+
+### Pre-commit Hook
+
+Add to `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+  - repo: local
+    hooks:
+      - id: pycrosscheck
+        name: PyCrossCheck
+        entry: pycrosscheck detect
+        language: system
+        types: [python]
+```
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## 📄 License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## 🙏 Acknowledgments
+
+- Built on top of [Bandit](https://github.com/PyCQA/bandit) security analysis tool
+- Inspired by the need for better cross-platform Python code
+
+## 📞 Support
+
+- **Issues**: [GitHub Issues](https://github.com/yourusername/pycrosscheck/issues)
+- **Documentation**: [GitHub README](https://github.com/yourusername/pycrosscheck#readme)
+
+---
+
+Made with ❤️ for the Python community