An open API service indexing awesome lists of open source software.

https://github.com/hardmax71/charon


https://github.com/hardmax71/charon

python react software-development sotfware-quality

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          


Charon

Charon

[![Type Check](https://github.com/HardMax71/charon/actions/workflows/type-check.yml/badge.svg?branch=main)](https://github.com/HardMax71/charon/actions/workflows/type-check.yml)
[![Ruff](https://github.com/HardMax71/charon/actions/workflows/ruff.yml/badge.svg?branch=main)](https://github.com/HardMax71/charon/actions/workflows/ruff.yml)
[![Tests](https://github.com/HardMax71/charon/actions/workflows/backend-tests.yml/badge.svg?branch=main)](https://github.com/HardMax71/charon/actions/workflows/backend-tests.yml)
[![codecov](https://codecov.io/gh/HardMax71/charon/branch/main/graph/badge.svg)](https://codecov.io/gh/HardMax71/charon)


[![Docker Publish](https://github.com/HardMax71/charon/actions/workflows/docker-publish.yml/badge.svg?branch=main)](https://github.com/HardMax71/charon/actions/workflows/docker-publish.yml)
[![Release](https://github.com/HardMax71/charon/actions/workflows/release.yml/badge.svg)](https://github.com/HardMax71/charon/actions/workflows/release.yml)
[![docs: mkdocs](https://img.shields.io/badge/docs-mkdocs-blue.svg)](https://hardmax71.github.io/charon)


[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)

3D visualization of Python code dependencies. Paste a GitHub URL, see your architecture as an interactive graph. Red nodes are circular dependencies, orange ones are highly coupled.

## Quick Start

```bash
docker compose up
```

Open http://localhost:5173, paste a repo URL, done.

Without Docker:

```bash
# Backend
cd backend && uv sync && uv run uvicorn app.main:app --reload

# Frontend
cd frontend && npm install && npm run dev
```

## Features

- **3D graph** — files as nodes, imports as edges, drag/zoom/click
- **Metrics** — coupling, cohesion, circular dependency detection
- **Layouts** — hierarchical, force-directed, circular
- **Analysis** — temporal evolution, impact analysis, refactoring suggestions
- **Export** — JSON, diagrams, docs

Full details in the [documentation](https://hardmax71.github.io/charon).

## License

[MIT](LICENSE)