depcycle 0.2.0__tar.gz

depcycle-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Kishan Thanki
+
+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.

depcycle-0.2.0/PKG-INFO

@@ -0,0 +1,264 @@
+Metadata-Version: 2.4
+Name: depcycle
+Version: 0.2.0
+Summary: Command-line tool to visualize Python project dependencies.
+Author: DepCycle Maintainers
+License: MIT License
+        
+        Copyright (c) 2025 Kishan Thanki
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/Matricess/depcycle
+Project-URL: Repository, https://github.com/Matricess/depcycle
+Project-URL: Issues, https://github.com/Matricess/depcycle/issues
+Keywords: dependencies,graphviz,architecture,visualization,cli
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: graphviz>=0.20.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+# DepCycle
+
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**DepCycle** is a command-line tool to visualize Python project dependencies. It helps developers understand complex codebases by automatically generating visual maps of how modules are connected, making it easy to spot architectural problems like **circular dependencies** and untangle coupled code.
+
+## Features
+
+- **Automatic Dependency Discovery**: Scans Python projects and builds a complete dependency graph
+- **Cycle Detection**: Identifies circular dependencies that can lead to architectural issues
+- **Flexible Visualization**: Multiple output formats including PNG, SVG, and HTML
+- **Smart Filtering**: Exclude specific patterns, third-party libraries, or standard library modules
+- **AST-Based Parsing**: Uses Python's Abstract Syntax Tree for accurate import detection
+
+## Links
+
+- **Repository:** https://github.com/Matricess/depcycle.git
+- **Tests:** https://github.com/Matricess/depcycle/tree/main/tests
+- **Design commentary:** https://github.com/Matricess/depcycle/blob/main/DESIGN.md
+- **Sample dependency graph:** `examples/` (local)
+
+## Prerequisites
+
+- Python 3.8 or higher
+- [Graphviz](https://graphviz.org/download/) (for PNG/SVG output)
+
+### Installing Graphviz
+
+**macOS:**
+```bash
+brew install graphviz
+```
+
+**Ubuntu/Debian:**
+```bash
+sudo apt-get install graphviz
+```
+
+**Windows:**
+Download and install from [Graphviz website](https://graphviz.org/download/)
+
+## Installation
+
+### Install via pip (recommended)
+
+```bash
+pip install depcycle
+
+or 
+
+# install directly from GitHub
+pip install git+https://github.com/Matricess/depcycle.git
+```
+
+### Install from a clone (editable dev setup)
+
+```bash
+git clone https://github.com/Matricess/depcycle.git
+cd depcycle
+pip install -e .[dev]
+```
+
+If you prefer requirements files, `pip install -r requirements.txt` will install runtime deps plus `pytest` for the test suite.
+
+## Usage
+
+### Basic Usage
+
+Analyze a Python project and generate a dependency graph (PNG by default):
+
+```bash
+depcycle /path/to/your/project
+```
+
+The output is written to `dependencies.png` in the current working directory.
+
+> **Note:** By default DepCycle skips common noise directories such as `venv/`, `.venv/`, `.git/`, `__pycache__/`, `node_modules/`, build artifacts, and Python cache folders. Use `-e` flags if you need extra exclusions, or disable the defaults via the API (`Project.get_python_files(include_defaults=False)`).
+
+### Using as a Module
+
+```bash
+python -m depcycle /path/to/your/project
+```
+
+### Advanced Options
+
+Generate a different output format or explicit location:
+
+```bash
+depcycle /path/to/project --format svg --output diagrams/dependencies.svg
+```
+
+Exclude specific directories or files (glob syntax):
+
+```bash
+depcycle /path/to/project -e venv -e ".*/tests/*" -e "*.test.py"
+```
+
+Focus only on local code:
+
+```bash
+depcycle /path/to/project --no-third-party --no-stdlib
+```
+
+**Full help:**
+
+```bash
+depcycle --help
+```
+
+## Tests
+
+Tests live under `tests/` and run without touching the sample projects in `examples/`.
+
+```bash
+pip install -e .[dev]
+pytest -q
+```
+
+See [`tests/README.md`](tests/README.md) for a quick summary.
+
+## Project Structure
+
+```
+depcycle/
+├── src/
+│   └── depcycle/
+│       ├── __init__.py
+│       ├── __main__.py
+│       ├── cli.py                  # Command-line interface
+│       ├── config.py               # Configuration management
+│       ├── graph/
+│       │   ├── __init__.py
+│       │   ├── dependency_graph.py # Core graph logic
+│       │   └── module_node.py      # Module representation
+│       ├── parsing/
+│       │   ├── __init__.py
+│       │   ├── ast_parser.py       # AST-based import parsing
+│       │   └── project.py          # File discovery
+│       └── rendering/
+│           ├── __init__.py
+│           ├── interface.py        # Visualization interface
+│           └── visualizers.py      # Output implementations
+├── requirements.txt
+├── README.md
+└── LICENSE
+```
+
+## Architecture
+
+DepCycle follows a clean, modular architecture:
+
+1. **CLI Layer** (`cli.py`): Handles user input and orchestrates the workflow
+2. **Configuration** (`config.py`): Manages all settings and options
+3. **Graph Layer** (`graph/`): Core data structures for the dependency graph
+4. **Parsing Layer** (`parsing/`): Discovers files and extracts imports using AST
+5. **Rendering Layer** (`rendering/`): Generates visualizations in various formats
+
+## Key Classes
+
+- **`DepCycleCLI`**: Main entry point that handles command-line arguments
+- **`DependencyGraph`**: Central data structure holding all module relationships
+- **`ModuleNode`**: Represents a single Python module/file
+- **`Project`**: Discovers and manages Python files in a project
+- **`ASTParser`**: Extracts imports using Python's AST module
+- **`GraphvizVisualizer`**: Renders graphs as PNG/SVG images
+- **`HtmlVisualizer`**: Generates interactive HTML visualizations
+
+## How It Works
+
+1. **Discovery**: Recursively scans the project directory for all `.py` files
+2. **Parsing**: Uses Python's AST to extract import statements from each file
+3. **Resolution**: Maps import strings to actual modules in the project
+4. **Classification**: Categorizes modules as LOCAL, THIRD_PARTY, or STDLIB
+5. **Analysis**: Detects circular dependencies using depth-first search
+6. **Visualization**: Renders the graph using Graphviz or HTML
+
+## Example Output
+
+When you run DepCycle, you'll see output like:
+
+```
+Analyzing project: /path/to/my-project
+Building dependency graph...
+Found 42 modules
+✓ No circular dependencies detected
+Generating PNG visualization...
+✓ Visualization saved to: dependencies.png
+```
+
+If circular dependencies are found:
+
+```
+⚠️  Warning: Found 2 circular dependency cycles!
+  Cycle 1: app.models.user → app.services.auth → app.models.user
+  Cycle 2: app.core.database → app.core.config → app.core.database
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+Built as part of a Software Design and Testing course project (IT643).

depcycle-0.2.0/README.md

@@ -0,0 +1,210 @@
+# DepCycle
+
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**DepCycle** is a command-line tool to visualize Python project dependencies. It helps developers understand complex codebases by automatically generating visual maps of how modules are connected, making it easy to spot architectural problems like **circular dependencies** and untangle coupled code.
+
+## Features
+
+- **Automatic Dependency Discovery**: Scans Python projects and builds a complete dependency graph
+- **Cycle Detection**: Identifies circular dependencies that can lead to architectural issues
+- **Flexible Visualization**: Multiple output formats including PNG, SVG, and HTML
+- **Smart Filtering**: Exclude specific patterns, third-party libraries, or standard library modules
+- **AST-Based Parsing**: Uses Python's Abstract Syntax Tree for accurate import detection
+
+## Links
+
+- **Repository:** https://github.com/Matricess/depcycle.git
+- **Tests:** https://github.com/Matricess/depcycle/tree/main/tests
+- **Design commentary:** https://github.com/Matricess/depcycle/blob/main/DESIGN.md
+- **Sample dependency graph:** `examples/` (local)
+
+## Prerequisites
+
+- Python 3.8 or higher
+- [Graphviz](https://graphviz.org/download/) (for PNG/SVG output)
+
+### Installing Graphviz
+
+**macOS:**
+```bash
+brew install graphviz
+```
+
+**Ubuntu/Debian:**
+```bash
+sudo apt-get install graphviz
+```
+
+**Windows:**
+Download and install from [Graphviz website](https://graphviz.org/download/)
+
+## Installation
+
+### Install via pip (recommended)
+
+```bash
+pip install depcycle
+
+or 
+
+# install directly from GitHub
+pip install git+https://github.com/Matricess/depcycle.git
+```
+
+### Install from a clone (editable dev setup)
+
+```bash
+git clone https://github.com/Matricess/depcycle.git
+cd depcycle
+pip install -e .[dev]
+```
+
+If you prefer requirements files, `pip install -r requirements.txt` will install runtime deps plus `pytest` for the test suite.
+
+## Usage
+
+### Basic Usage
+
+Analyze a Python project and generate a dependency graph (PNG by default):
+
+```bash
+depcycle /path/to/your/project
+```
+
+The output is written to `dependencies.png` in the current working directory.
+
+> **Note:** By default DepCycle skips common noise directories such as `venv/`, `.venv/`, `.git/`, `__pycache__/`, `node_modules/`, build artifacts, and Python cache folders. Use `-e` flags if you need extra exclusions, or disable the defaults via the API (`Project.get_python_files(include_defaults=False)`).
+
+### Using as a Module
+
+```bash
+python -m depcycle /path/to/your/project
+```
+
+### Advanced Options
+
+Generate a different output format or explicit location:
+
+```bash
+depcycle /path/to/project --format svg --output diagrams/dependencies.svg
+```
+
+Exclude specific directories or files (glob syntax):
+
+```bash
+depcycle /path/to/project -e venv -e ".*/tests/*" -e "*.test.py"
+```
+
+Focus only on local code:
+
+```bash
+depcycle /path/to/project --no-third-party --no-stdlib
+```
+
+**Full help:**
+
+```bash
+depcycle --help
+```
+
+## Tests
+
+Tests live under `tests/` and run without touching the sample projects in `examples/`.
+
+```bash
+pip install -e .[dev]
+pytest -q
+```
+
+See [`tests/README.md`](tests/README.md) for a quick summary.
+
+## Project Structure
+
+```
+depcycle/
+├── src/
+│   └── depcycle/
+│       ├── __init__.py
+│       ├── __main__.py
+│       ├── cli.py                  # Command-line interface
+│       ├── config.py               # Configuration management
+│       ├── graph/
+│       │   ├── __init__.py
+│       │   ├── dependency_graph.py # Core graph logic
+│       │   └── module_node.py      # Module representation
+│       ├── parsing/
+│       │   ├── __init__.py
+│       │   ├── ast_parser.py       # AST-based import parsing
+│       │   └── project.py          # File discovery
+│       └── rendering/
+│           ├── __init__.py
+│           ├── interface.py        # Visualization interface
+│           └── visualizers.py      # Output implementations
+├── requirements.txt
+├── README.md
+└── LICENSE
+```
+
+## Architecture
+
+DepCycle follows a clean, modular architecture:
+
+1. **CLI Layer** (`cli.py`): Handles user input and orchestrates the workflow
+2. **Configuration** (`config.py`): Manages all settings and options
+3. **Graph Layer** (`graph/`): Core data structures for the dependency graph
+4. **Parsing Layer** (`parsing/`): Discovers files and extracts imports using AST
+5. **Rendering Layer** (`rendering/`): Generates visualizations in various formats
+
+## Key Classes
+
+- **`DepCycleCLI`**: Main entry point that handles command-line arguments
+- **`DependencyGraph`**: Central data structure holding all module relationships
+- **`ModuleNode`**: Represents a single Python module/file
+- **`Project`**: Discovers and manages Python files in a project
+- **`ASTParser`**: Extracts imports using Python's AST module
+- **`GraphvizVisualizer`**: Renders graphs as PNG/SVG images
+- **`HtmlVisualizer`**: Generates interactive HTML visualizations
+
+## How It Works
+
+1. **Discovery**: Recursively scans the project directory for all `.py` files
+2. **Parsing**: Uses Python's AST to extract import statements from each file
+3. **Resolution**: Maps import strings to actual modules in the project
+4. **Classification**: Categorizes modules as LOCAL, THIRD_PARTY, or STDLIB
+5. **Analysis**: Detects circular dependencies using depth-first search
+6. **Visualization**: Renders the graph using Graphviz or HTML
+
+## Example Output
+
+When you run DepCycle, you'll see output like:
+
+```
+Analyzing project: /path/to/my-project
+Building dependency graph...
+Found 42 modules
+✓ No circular dependencies detected
+Generating PNG visualization...
+✓ Visualization saved to: dependencies.png
+```
+
+If circular dependencies are found:
+
+```
+⚠️  Warning: Found 2 circular dependency cycles!
+  Cycle 1: app.models.user → app.services.auth → app.models.user
+  Cycle 2: app.core.database → app.core.config → app.core.database
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+Built as part of a Software Design and Testing course project (IT643).

depcycle-0.2.0/pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "depcycle"
+version = "0.2.0"
+description = "Command-line tool to visualize Python project dependencies."
+readme = "README.md"
+requires-python = ">=3.8"
+license = { file = "LICENSE" }
+authors = [
+  { name = "DepCycle Maintainers" }
+]
+keywords = ["dependencies", "graphviz", "architecture", "visualization", "cli"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Software Development :: Build Tools",
+  "Topic :: Software Development :: Testing",
+  "Topic :: Utilities"
+]
+dependencies = [
+  "graphviz>=0.20.0",
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=7.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/Matricess/depcycle"
+Repository = "https://github.com/Matricess/depcycle"
+Issues = "https://github.com/Matricess/depcycle/issues"
+
+[project.scripts]
+depcycle = "depcycle.cli:DepCycleCLI.main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["depcycle*"]
+

depcycle-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

depcycle-0.2.0/src/depcycle/__init__.py

@@ -0,0 +1,28 @@
+"""
+DepCycle - A dependency graph visualization tool for Python projects.
+
+DepCycle helps developers understand complex codebases by automatically 
+generating visual maps of module dependencies.
+"""
+
+__version__ = "0.2.0"
+
+from .cli import DepCycleCLI
+from .config import Config
+from .graph import DependencyGraph, ModuleNode, ModuleType
+from .parsing import Project, ASTParser
+from .rendering import IGraphVisualizer, GraphvizVisualizer, HtmlVisualizer
+
+__all__ = [
+    'DepCycleCLI',
+    'Config',
+    'DependencyGraph',
+    'ModuleNode',
+    'ModuleType',
+    'Project',
+    'ASTParser',
+    'IGraphVisualizer',
+    'GraphvizVisualizer',
+    'HtmlVisualizer',
+]
+

depcycle-0.2.0/src/depcycle/__main__.py

@@ -0,0 +1,7 @@
+"""Entry point for running depcycle as a module: python -m depcycle"""
+
+from .cli import DepCycleCLI
+
+if __name__ == '__main__':
+    DepCycleCLI.main()
+