update README.md, add publish to github pages demo

Author: xnuinside

.github/workflows/main.yml

@@ -6,6 +6,11 @@ on:
   pull_request:
     branches: [ main ]
 
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
 jobs:
   lint:
     runs-on: ubuntu-latest
@@ -44,24 +49,37 @@ jobs:
       run: |
         pytest tests/ -v
 
-  tox:
+  deploy-demo:
     runs-on: ubuntu-latest
-    needs: [lint]
+    needs: [tests]
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
     steps:
     - uses: actions/checkout@v4
-    - name: Set up Python versions
+    - name: Set up Python 3.12
       uses: actions/setup-python@v5
       with:
-        python-version: |
-          3.9
-          3.10
-          3.11
-          3.12
-          3.13
-    - name: Install tox
+        python-version: "3.12"
+    - name: Install codegraph
       run: |
         python -m pip install --upgrade pip
-        pip install tox
-    - name: Run tox
+        pip install matplotlib networkx click
+        pip install -e .
+    - name: Clone simple-ddl-parser for demo
+      run: |
+        git clone --depth 1 https://github.com/xnuinside/simple-ddl-parser.git /tmp/simple-ddl-parser
+    - name: Generate demo page
       run: |
-        tox
+        mkdir -p docs
+        codegraph /tmp/simple-ddl-parser/simple_ddl_parser --output docs/index.html
+    - name: Setup Pages
+      uses: actions/configure-pages@v4
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: 'docs'
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

CHANGELOG.md

@@ -5,6 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.1] - 2025-01-17
+
+### Added
+
+- **Live Demo**: Interactive demo available at [xnuinside.github.io/codegraph](https://xnuinside.github.io/codegraph/)
+- **GitHub Pages CI/CD**: Automatic demo deployment on merge to main
+
+### Changed
+
+- **Import-based module connections**: Module-to-module links now created based on imports, not just entity usage. This ensures connections are shown even when importing variables or constants (not just functions/classes)
+- **Renamed "Unused Modules" to "Unlinked"**: Panel now shows only modules with no connections at all (neither incoming nor outgoing), instead of just modules not imported by others
+
+### Fixed
+
+- Fixed missing module connections when imported names are variables (like `dialect_by_name`) rather than functions/classes
+
 ## [1.0.0] - 2025-01-17
 
 ### Added
@@ -57,7 +73,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - KeyError when analyzing codebases with external imports not in the analyzed path
 - Now gracefully skips modules not found in the analyzed codebase
 - Comma-separated imports now properly parsed (e.g., `from package import a, b, c`)
-- Fixed missing connections when imports use comma-separated syntax
+- Multi-line imports with parentheses now properly parsed
+- Fixed missing connections when imports use comma-separated or multi-line syntax
+
+### Added
+- **Class inheritance detection**: Classes now show connections to their base classes
+- Supports single and multiple inheritance: `class Child(Base1, Base2)`
+- Supports multi-line inheritance declarations
+- **`__init__.py` support**: Now includes `__init__.py` files in analysis
+- Re-export connections from `__init__.py` are shown as dependencies
+- **Unused Modules Panel**: Shows list of modules not imported by any other module
+- Click on module name to navigate and zoom to it on the graph
+- **Full Path in Tooltip**: Hovering over modules now shows relative path (e.g., "Full Path: tests/test_comments.py")
+
+### Changed
+- Replaced print statements with logging/click.echo for proper CLI output
 
 ### Testing
 - Added comprehensive test suite for graph generation (`tests/test_graph_generation.py`)

README.md

@@ -2,138 +2,70 @@
 
 ![badge1](https://img.shields.io/pypi/v/codegraph) ![badge2](https://img.shields.io/pypi/l/codegraph) ![badge3](https://img.shields.io/pypi/pyversions/codegraph)![workflow](https://github.com/xnuinside/codegraph/actions/workflows/main.yml/badge.svg)
 
-Tool that create a digram with your code structure to show dependencies between code entities (methods, modules, classes and etc).
-Main advantage of CodeGraph, that is does not execute the code itself. You not need to activate any environments or install dependencies to analyse the target code. 
-It is based only on lex and syntax parse, so it not need to install all your code dependencies.
+**[Live Demo](https://xnuinside.github.io/codegraph/)** - Interactive visualization of [simple-ddl-parser](https://github.com/xnuinside/simple-ddl-parser) codebase
 
+Tool that creates a diagram with your code structure to show dependencies between code entities (methods, modules, classes and etc).
+Main advantage of CodeGraph is that it does not execute the code itself. You don't need to activate any environments or install dependencies to analyze the target code.
+It is based only on lexical and syntax parsing, so it doesn't need to install all your code dependencies.
 
-### Install codegraph
-```console
-  
-    pip install codegraph
+### Interactive Visualization
 
-```
+![Interactive Code Visualization](docs/img/interactive_code_visualization.png)
 
-### Analyze your code
+**Zoom, Pan & Drag** - Use mouse wheel to zoom, drag background to pan, drag nodes to reposition them.
 
-codegraph - name of command line tool for CodeGrapg
+### Search & Highlight
 
-```console
+![Node Search](docs/img/node_search.png)
 
-    codegraph /path/to/your_python_code
-    # path must be absolute
+**Search with Autocomplete** - Press `Ctrl+F` (or `Cmd+F` on Mac) to search. Results show node type with color coding.
 
-    # or for one file
+![Highlight Nodes](docs/img/highlight_nodes.png)
 
-    codegraph /path/to/your_python_code
+**Highlight Connections** - Click on any node to highlight it and all connected nodes. Others will be dimmed.
 
-```
+### Node Information
 
-your_python_code - module with your python code
+![Node Information](docs/img/node_information.png)
 
-For example, if I put codegraph in my user home directory path will be:
+**Tooltips** - Hover over any node to see details: type, parent module, full path, and connection count.
 
-    codegraph /Users/myuser/codegraph/codegraph
+### Unlinked Modules
 
-Pass '-o' flag if you want only print dependencies in console and don't want graph visualisation
+![Unlinked Nodes](docs/img/listing_unlinked_nodes.png)
 
-    codegraph /path/to/your_python_code -o
+**Unlinked Panel** - Shows modules with no connections. Click to navigate to them on the graph.
 
-If you want to change view and play with graph output - you can check 'vizualyzer.py'
-and play with matplotlib and networkX settings.
+### UI Tips
 
-### Colors meanings 
-In default view - **red line** show dependencies between entities in different modules.
-**Green** - links between objects/functions inside same module.
+![UI Tips](docs/img/tips_in_ui.png)
 
-![Graph visualisation](https://github.com/xnuinside/codegraph/blob/main/docs/img/graph_visualisation.png "Graph visualisation")
+**Built-in Help** - Legend and keyboard shortcuts are always visible in the UI.
 
-![ Code with not used module](https://github.com/xnuinside/codegraph/blob/main/docs/img/code_with_trash_module.png "Code with not used module")
+---
 
-![Code there all modules linked together](https://github.com/xnuinside/codegraph/blob/main/docs/img/normal_code.png "Code there all modules linked together")
+### Installation
 
-### TODO
+```console
+pip install codegraph
+```
 
-    1. Create normal readme
-    2. Add tests
-    3. Work on visual part of Graph (now it is not very user friendly)
-    4. Add support to variables (names) as entities
-    5. Split usage & inheritance as a different cases
+### Usage
+
+```console
+codegraph /path/to/your_python_code
+```
+
+This will generate an interactive HTML visualization and open it in your browser.
+
+### CLI Options
+
+| Option | Description |
+|--------|-------------|
+| `--output PATH` | Custom output path for HTML file (default: `./codegraph.html`) |
+| `--matplotlib` | Use legacy matplotlib visualization instead of D3.js |
+| `-o, --object-only` | Print dependencies to console only, no visualization |
 
 ## Changelog
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [1.0.0] - 2025-01-17
-
-### Added
-
-**Interactive D3.js Visualization (New Default)**
-- D3.js visualization is now the default instead of matplotlib
-- Zoom & Pan: Mouse wheel to zoom, drag background to pan
-- Drag nodes: Reposition individual nodes by dragging
-- Collapse/Expand: Click on modules or entities to collapse/expand their children
-- Double-click: Focus and zoom to any node
-- Tooltips: Hover over nodes to see details (type, parent module, connection count)
-- Auto zoom-to-fit: Graph automatically fits to screen after loading
-
-**Module-to-Module Connections**
-- Orange links now show dependencies between .py files
-- Visual representation of which modules depend on which
-- Module connections are always visible even when entities are collapsed
-
-**Search with Autocomplete**
-- Search box at the top center of the visualization
-- Ctrl+F (Cmd+F on Mac) to focus search
-- Autocomplete dropdown with up to 10 matching results
-- Results show node type (module/entity/external) with color coding
-- Arrow keys to navigate, Enter to select, Esc to close
-- Highlighting: Selected node and its connections are highlighted, others dimmed
-- Info panel shows number of connected nodes
-
-**Visual Design**
-- Modules: Green squares (larger)
-- Entities: Blue circles (functions/classes)
-- External dependencies: Gray circles
-- Module-to-Module links: Orange, thick (3px)
-- Module-to-Entity links: Green, dashed
-- Entity-to-Dependency links: Red
-- Statistics panel showing module count, entity count, and module connections
-- Legend explaining all node and link types
-- Dark theme with high contrast
-
-**CLI Options**
-- `--matplotlib` flag to use legacy matplotlib visualization
-- `--output PATH` to specify custom output path for HTML file
-- Default output: `./codegraph.html` (current working directory)
-
-### Changed
-- Default visualization changed from matplotlib to D3.js
-- `draw_graph()` now generates interactive HTML instead of matplotlib window
-- Renamed `draw_graph()` to `draw_graph_matplotlib()` for legacy visualization
-
-### Fixed
-- KeyError when analyzing codebases with external imports not in the analyzed path
-- Now gracefully skips modules not found in the analyzed codebase
-- Comma-separated imports now properly parsed (e.g., `from package import a, b, c`)
-- Fixed missing connections when imports use comma-separated syntax
-
-### Testing
-- Added comprehensive test suite for graph generation (`tests/test_graph_generation.py`)
-- Tests for import parsing: simple imports, comma-separated, aliased imports
-- Tests for CodeGraph connections between modules
-- Tests for D3.js format conversion
-- Tests verifying codegraph can analyze its own codebase
-- Support for Python 3.9, 3.10, 3.11, 3.12, 3.13
-- Added `tox.ini` for multi-version testing
-- Added GitHub Actions CI matrix for all supported Python versions
-
-## [0.1.0] - Previous
-
-### Added
-- Initial matplotlib visualization
-- Basic dependency graph generation
-- CLI interface with click
-- Support for Python 3.12+
+
+See [CHANGELOG.md](CHANGELOG.md) for full version history.

build.sh

@@ -1,19 +1,4 @@
 #!/bin/bash
-# Build script for codegraph
-# https://github.com/python-poetry/poetry/pull/3733
-
-set -e
-
-# Create README with changelog from CHANGELOG.md
-sed '/## Changelog/q' README.md > new_README.md
-# Skip the header line "# Changelog" from CHANGELOG.md and append the rest
-tail -n +3 CHANGELOG.md >> new_README.md
-rm README.md
-mv new_README.md README.md
-
-# Convert to RST for PyPI
-m2r2 README.md
-mv README.rst docs/README.rst
 
 # Build package
 rm -rf dist