https://github.com/tapeline/aisle

Simplest C4-like diagramming solution
https://github.com/tapeline/aisle

c4-model docs documentation plantuml python

Last synced: 11 months ago
JSON representation

Simplest C4-like diagramming solution

• Host: GitHub
• URL: https://github.com/tapeline/aisle
• Owner: Tapeline
• License: gpl-3.0
• Created: 2025-01-30T21:20:29.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2025-06-10T11:21:42.000Z (about 1 year ago)
• Last Synced: 2025-06-10T12:23:44.201Z (about 1 year ago)
• Topics: c4-model, docs, documentation, plantuml, python
• Language: Python
• Homepage: https://tapeline.github.io/Aisle
• Size: 334 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Aisle

---

![type checked: mypy](https://img.shields.io/badge/mypy-type%20checked-green)

![coverage: 100](https://img.shields.io/badge/coverage-100%25-green)

[![import-linter](https://img.shields.io/badge/import%20linter-checked-green)](https://github.com/seddonym/import-linter)

[![ruff](https://img.shields.io/badge/style-ruff-41B5BE?style=flat)](https://github.com/astral-sh/ruff)

[![wemake-python-styleguide](https://img.shields.io/badge/style-wemake-000000.svg)](https://github.com/wemake-services/wemake-python-styleguide)

![python 3.12+](https://img.shields.io/badge/python-3.12+-blue)

[![License](https://img.shields.io/badge/license-GNU%20GPLv3-green)](./LICENSE)

[![test](https://github.com/Tapeline/Aisle/actions/workflows/test.yml/badge.svg?branch=master&event=push)](https://github.com/Tapeline/Aisle/actions/workflows/test.yml)

[![test](https://github.com/Tapeline/Aisle/actions/workflows/docs.yml/badge.svg?branch=master&event=push)](https://github.com/Tapeline/Aisle/actions/workflows/docs.yml)

Create C4 architecture diagrams of your project in no time.

---

  * [Description](#description)

  * [Installation](#installation)

  * [Usage](#usage)

  * [Planned features](#planned-features)

  * [Tech stack](#tech-stack)

  * [Developer](#developer)

  * [License](#license)

---

## Description

Aisle is a markup language and transpiling tool that aims to

be as simple and straightforward as possible when creating

architectural diagrams. Unlike other solutions it has very

simple and natural syntax, which makes it easier to start

and then understand your diagram.

## Installation

> Prerequisite: Python 3.12+, pip

```shell

pip install aisle

```

## Usage

Please refer to the [documentation](https://tapeline.github.io/Aisle/docs/)

## Planned features

- [ ] Styling

- [ ] Icons

- [x] D2 as code generation target

## Tech stack

![python 3.12+](https://img.shields.io/badge/python-3.12+-blue)

## Developer

Project is being developed by [@Tapeline](https://github.com/Tapeline)

## License

This work is licensed under GNU General Public License v3.0