pyfixit-cli 0.1.0__py3-none-any.whl

pyfixit_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,507 @@
+Metadata-Version: 2.4
+Name: pyfixit-cli
+Version: 0.1.0
+Summary: Diagnose common Python import and dependency problems
+Author: Dhanunjay
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: packaging>=22
+Dynamic: license-file
+
+# PyFixIt
+
+### Python Project Troubleshooter
+
+PyFixIt is a command-line tool that analyzes Python projects and diagnoses common import and dependency problems.
+
+It can detect:
+
+- Missing dependencies
+- Undeclared dependencies
+- Version conflicts
+- Unused dependencies
+- Standard-library modules
+- Local project modules
+- Package-name differences such as `sklearn -> scikit-learn`
+
+---
+
+## Features
+
+### Dependency Diagnosis
+
+PyFixIt analyzes Python files in a project and compares the detected imports with `requirements.txt`.
+
+Example:
+
+```text
+[PROBLEM] sklearn
+
+  Status: missing_installation
+
+  Fix: pip install scikit-learn
+```
+
+---
+
+### Version Conflict Detection
+
+PyFixIt checks installed versions against the versions specified in `requirements.txt`.
+
+Example:
+
+```text
+[VERSION CONFLICT] requests
+
+  Required: ==2.30.0
+
+  Installed: 2.34.2
+
+  Fix: pip install requests==2.30.0
+```
+
+---
+
+### Missing Declaration Detection
+
+If a package is installed and imported but not declared in `requirements.txt`, PyFixIt reports it.
+
+Example:
+
+```text
+[PROBLEM] pandas
+
+  Status: missing_declaration
+
+  Fix: Add 'pandas' to requirements.txt
+```
+
+---
+
+### Unused Dependency Detection
+
+PyFixIt can identify packages listed in `requirements.txt` that are not imported by the project.
+
+Example:
+
+```text
+[UNUSED] numpy
+
+  Fix: Remove 'numpy' from requirements.txt
+```
+
+---
+
+### Requirements Cleanup
+
+You can preview unused dependencies:
+
+```bash
+pyfixit clean .
+```
+
+Then apply the cleanup:
+
+```bash
+pyfixit clean . --apply
+```
+
+---
+
+## Installation
+
+### From Source
+
+Clone the repository:
+
+```bash
+git clone <YOUR_GITHUB_REPOSITORY_URL>
+```
+
+Navigate into the project:
+
+```bash
+cd pyfixit
+```
+
+Create a virtual environment:
+
+```bash
+python -m venv .venv
+```
+
+### Windows
+
+Activate the virtual environment:
+
+```bash
+.venv\Scripts\activate
+```
+
+### Linux / macOS
+
+Activate the virtual environment:
+
+```bash
+source .venv/bin/activate
+```
+
+Install PyFixIt in editable mode:
+
+```bash
+python -m pip install -e .
+```
+
+---
+
+## Usage
+
+### Diagnose a Project
+
+Run:
+
+```bash
+pyfixit diagnose .
+```
+
+Example output:
+
+```text
+PyFixIt v0.1.0
+Python Project Troubleshooter
+
+Dependencies
+------------------------------
+
+[PROBLEM] sklearn
+
+  Status: missing_installation
+
+  Fix: pip install scikit-learn
+
+[VERSION CONFLICT] requests
+
+  Required: ==2.30.0
+
+  Installed: 2.34.2
+
+  Fix: pip install requests==2.30.0
+
+[PROBLEM] pandas
+
+  Status: missing_declaration
+
+  Fix: Add 'pandas' to requirements.txt
+
+
+Unused dependencies
+------------------------------
+
+[UNUSED] numpy
+
+  Fix: Remove 'numpy' from requirements.txt
+```
+
+You can also use the shorthand:
+
+```bash
+pyfixit .
+```
+
+---
+
+## Check a Project
+
+The `check` command provides a quick project health summary.
+
+Run:
+
+```bash
+pyfixit check .
+```
+
+Example:
+
+```text
+PyFixIt v0.1.0
+Python Project Troubleshooter
+
+Checking project...
+
+[FAIL] 4 dependency problems found
+
+[OK] No unused dependencies found
+```
+
+For a clean project:
+
+```text
+PyFixIt v0.1.0
+Python Project Troubleshooter
+
+Checking project...
+
+[OK] No dependency problems found
+
+[OK] No unused dependencies found
+```
+
+PyFixIt also uses exit codes, so it can be used in scripts and CI pipelines.
+
+---
+
+## JSON Output
+
+For machine-readable diagnosis results:
+
+```bash
+pyfixit diagnose . --json
+```
+
+Example:
+
+```json
+{
+  "dependencies": [
+    {
+      "module": "sklearn",
+      "package_name": "scikit-learn",
+      "import_name": "sklearn",
+      "declared": true,
+      "installed": false,
+      "installed_version": null,
+      "required_version": null,
+      "operator": null,
+      "status": "missing_installation"
+    }
+  ],
+  "unused_dependencies": [
+    "numpy"
+  ]
+}
+```
+
+JSON output can be useful for automation, CI tools, and other developer tooling.
+
+---
+
+## Clean Requirements
+
+PyFixIt can identify unused dependencies and optionally remove them from `requirements.txt`.
+
+### Preview Unused Dependencies
+
+Run:
+
+```bash
+pyfixit clean .
+```
+
+Example:
+
+```text
+Cleaning requirements.txt
+------------------------------
+
+[REMOVE] numpy
+
+1 unused dependencies found.
+
+Run 'pyfixit clean . --apply' to remove them.
+```
+
+### Apply the Cleanup
+
+Run:
+
+```bash
+pyfixit clean . --apply
+```
+
+Example:
+
+```text
+Cleaning requirements.txt
+------------------------------
+
+[REMOVED] numpy
+
+1 dependencies removed.
+```
+
+Running the command again will show:
+
+```text
+Cleaning requirements.txt
+------------------------------
+
+Nothing to remove.
+```
+
+---
+
+## Available Commands
+
+| Command | Description |
+|---|---|
+| `pyfixit diagnose .` | Diagnose project dependencies |
+| `pyfixit check .` | Quickly check project health |
+| `pyfixit clean .` | Preview unused dependencies |
+| `pyfixit clean . --apply` | Remove unused dependencies |
+| `pyfixit diagnose . --json` | Output diagnosis as JSON |
+| `pyfixit --help` | Show help |
+| `pyfixit --version` | Show version |
+
+---
+
+## What PyFixIt Checks
+
+PyFixIt analyzes imports and classifies them into three categories:
+
+```text
+Standard Library
+|
++-- pathlib
++-- sys
++-- ast
+
+Local Modules
+|
++-- project files
++-- project packages
+
+Third-Party Modules
+|
++-- requests
++-- pandas
++-- fastapi
++-- sklearn
+```
+
+Only third-party modules are checked against project dependencies.
+
+This prevents standard-library and local project modules from being incorrectly reported as missing dependencies.
+
+---
+
+## Package Name Mapping
+
+Some Python import names are different from their package names.
+
+For example:
+
+```python
+import sklearn
+```
+
+The package is installed using:
+
+```bash
+pip install scikit-learn
+```
+
+PyFixIt handles this distinction automatically.
+
+```text
+Import name:  sklearn
+
+Package name: scikit-learn
+```
+
+This allows PyFixIt to provide more accurate installation suggestions.
+
+---
+
+## Requirements
+
+PyFixIt currently requires:
+
+- Python 3.10+
+- `packaging >= 22`
+
+---
+
+## Development
+
+Clone the repository and install it in editable mode:
+
+```bash
+python -m pip install -e .
+```
+
+Install pytest:
+
+```bash
+python -m pip install pytest
+```
+
+Run the test suite:
+
+```bash
+python -m pytest
+```
+
+### Test Status
+
+Current test suite:
+
+```text
+47 passed
+```
+
+---
+
+## Project Structure
+
+```text
+pyfixit/
+|
++-- src/
+|   +-- pyfixit/
+|       +-- __init__.py
+|       +-- cleaner.py
+|       +-- cli.py
+|       +-- dependencies.py
+|       +-- diagnostics.py
+|       +-- environment.py
+|       +-- imports.py
+|       +-- module_classifier.py
+|       +-- package_mapping.py
+|       +-- package_names.py
+|       +-- requirements_parser.py
+|
++-- tests/
+|   +-- test_cleaner.py
+|   +-- test_cli.py
+|   +-- test_diagnostics.py
+|   +-- test_package_names.py
+|   +-- test_requirements_parser.py
+|
++-- pyproject.toml
++-- README.md
++-- requirements.txt
+```
+
+---
+
+## Version
+
+**Current version: `0.1.0`**
+
+PyFixIt is currently in its initial release.
+
+---
+
+## License
+
+This project is licensed under the MIT License.

pyfixit_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+pyfixit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyfixit/cleaner.py,sha256=Z_XtSg0PLfTXYP-MUcYWAtiVCXYQ9E3RRtRXnuqPtKM,1486
+pyfixit/cli.py,sha256=6JPO3YJJBpG_JUfo1tBh8ZwpBg7sUcBa7CBgvXbbGNQ,6048
+pyfixit/dependencies.py,sha256=Ild2XnOnpLoAxW3-VOiG9bXh1ZmGCkHUz7GijUJIPfw,746
+pyfixit/diagnostics.py,sha256=c4K6CG_wFUvcW-eXOQMTKzR5pyZoIcrcZJjfYP8U4uY,6212
+pyfixit/environment.py,sha256=psmEy3ozcn2ADZa4S4nntyjB192mV_VDd9aitSf5Uao,484
+pyfixit/imports.py,sha256=R4f1W_fgpdH56RpyUSpMsf7zQvDMSm-2llOHnOA4DRM,1945
+pyfixit/module_classifier.py,sha256=rVMBnX7b3MuhKvEUsIhIm_ejFhtCGq5s_Xgy0zizFrg,1417
+pyfixit/package_mapping.py,sha256=I6wh6wsEtSwiJfR4oeoSzl8AC6ykpI6jBVIMezs8iYU,395
+pyfixit/package_names.py,sha256=-QeuquPH2fsI1a6jSMRnIILQq-3GijvoxnkbyYjodws,652
+pyfixit/requirements_parser.py,sha256=m-CMHrNVFng3-6o_MaMiY_kRkE5n3p4wAyCULjnMVso,1336
+pyfixit_cli-0.1.0.dist-info/licenses/LICENSE,sha256=affvXa6Im__h90lD3-Vl7qCfEeVHotbGKkLfaJZmoHM,1085
+pyfixit_cli-0.1.0.dist-info/METADATA,sha256=r2_UWxrimz1BMJssu4ZWY_B7QF5Md7m_FIqDln3pX3w,8070
+pyfixit_cli-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+pyfixit_cli-0.1.0.dist-info/entry_points.txt,sha256=ubDjoIWw1ZbD88Jh4KuZq0DqMGUkwLhZRjWOxkRBxuo,45
+pyfixit_cli-0.1.0.dist-info/top_level.txt,sha256=II0d-gKlvPjfQ4FtlY49YX5fUZ7bSBz5Tvl2tyJ9-RE,8
+pyfixit_cli-0.1.0.dist-info/RECORD,,

pyfixit_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pyfixit_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pyfixit = pyfixit.cli:main

pyfixit_cli-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Dhanunjay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyfixit_cli-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyfixit