Metadata-Version: 2.4
Name: codeatlas
Version: 0.1.0
Summary: A Python library for visualizing and understanding codebases.
Home-page: https://github.com/rahulbedjavalge/codeatlas
Author: Rahul Bedjavalge
Author-email: rahulinberlinn@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: flask
Requires-Dist: networkx
Requires-Dist: click
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# CodeAtlas

## 🚀 Overview
CodeAtlas is a groundbreaking Python library designed to help developers visualize and comprehend their codebases effortlessly. By generating interactive and intuitive diagrams, CodeAtlas provides insights into the structure and flow of your Python projects, facilitating better understanding, maintenance, and collaboration.

## 🎯 Key Features
- **Function and Class Diagrams**: Automatically generate diagrams showcasing the relationships between functions and classes in your code.
- **Module Dependency Graphs**: Visualize how different modules in your project depend on each other.
- **Interactive Web Interface**: Explore your codebase through an interactive web interface with zooming, panning, and filtering capabilities.
- **Command-Line Interface (CLI)**: Easily integrate CodeAtlas into your workflow using its powerful CLI.
- **Export Options**: Export diagrams in various formats such as PNG, SVG, and PDF for documentation or presentations.

## 🧠 Why CodeAtlas?
Understanding complex codebases can be challenging, especially when onboarding new team members or revisiting old projects. While tools like Graphviz and Doxygen exist, they often require extensive configuration and lack interactivity. CodeAtlas fills this gap by providing an easy-to-use, interactive, and visually appealing way to explore Python codebases.

## 📦 Installation
To install CodeAtlas, use the following command:

```bash
pip install codeatlas
```

## 🛠️ Usage
To generate a graph for your Python project, run the following command:

```bash
python -m codeatlas.main --path <project_path> --output <output_file>
```

Example:

```bash
python -m codeatlas.main --path examples/sample_project --output demo_graph.png
```

## 🤝 Contributing
We welcome contributions from the community! Please see the `CONTRIBUTING.md` file for guidelines on how to contribute.

## 🚀 Future Plans
- Add module dependency graphs.
- Develop an interactive web interface for exploring codebases.
- Support exporting diagrams in SVG and PDF formats.
- Enhance CLI features for better usability.

## 📜 License
CodeAtlas is licensed under the MIT License. See the `LICENSE` file for more details.

---

Happy coding with CodeAtlas! 🎉
