Skip to main content

Architecture generator for Rust and C++/Qt applications.

Project description

PyPI - Version license quality GitHub commit activity

Qleany

Define your entities in YAML. Get a complete, tested architecture in C++20/Qt6 or Rust — controllers, repositories, undo/redo, reactive models, and ready-to-compile UIs.

No framework. No runtime. No Qleany dependencies in your code.

The generated code is yours — plain C++ classes and Rust structs using standard libraries (Qt, QCoro, redb). Modify it, extend it, delete Qleany afterward. You're not adopting a framework that will haunt your codebase for years or burn you when the maintainer moves on.

Qt provides excellent widgets and signals, but little guidance on organizing a 30,000-line application. Rust's GUI ecosystem is growing fast, but there's nothing to help you structure what sits behind the UI. Qleany fills that gap. Write a YAML manifest describing your entities, relationships, and features. Qleany generates the rest: the database layer, the repository infrastructure, the event system, the controller wiring, and — if you need it — a multi-stack undo/redo system with cascade snapshot/restore for entity trees. For C++/Qt, it also generates reactive QML models that update themselves, and JavaScript mock controllers so your UI developer can work without waiting for the backend.

Once the code is generated, your work is two things: fill in the use case bodies where the TODOs are, and build your UI. The rest is done. Think of it as getting the framework without adopting one.

For a 13-entity project, that's roughly 600 files in C++/Qt or 300 in Rust, all compiling, all internally consistent, with a generated test suite that validates the infrastructure before you write a single line of business logic. The generated code is deliberately straightforward — readable and modifiable by a developer with a few years of experience, not a showcase of advanced language features.

Qleany follows Package by Feature (Vertical Slice Architecture) principles. Define your entities and features once, generate consistent architecture across Rust and C++/Qt with baked-in (empty) UIs. Qleany's own Slint-based tool is built using the same patterns it generates.

Key Features

  • Complete CRUD infrastructure — Controllers, DTOs, use cases, repositories per entity
  • Undo/redo system (optional) — Command-based with multi-stack scoping, composite grouping, and failure strategies; async execution with QCoro coroutines in C++/Qt, synchronous in Rust; cascade snapshot/restore for entity trees
  • GUI skeleton generation — Ready-to-compile frontend code for QtQuick, QtWidgets, Slint, or CLI
  • Reactive QML models — Auto-updating list models and single-entity wrappers with event-driven refresh (C++/Qt)
  • QML mocks — JavaScript stubs that simulate async behavior, enabling UI development without a backend (C++/Qt)
  • Models — C++/Qt only: auto-updating list models and single-entity wrappers with event-driven refresh
  • Relationship management — Uniform junction tables with ordering, two-layer caching, bidirectional navigation, and cascade deletion
  • Event system — Thread-safe, decoupled communication between features
  • Event Buffer — Send events only if the command succeeds
  • Generated test suite — Junction table operations, undo/redo behavior, and async integration tests

Documentation

Document Purpose
Quick Start - Rust Step-by-step tutorial building a complete application
Quick Start - C++/Qt Step-by-step tutorial building a complete application
Manifest Reference Entity options, field types, relationships, features and use cases
Design Philosophy Clean Architecture background, package by feature, Rust module structure
How Operations Flow How data flows through the application, events
Regeneration Workflow How file generation works, what gets overwritten, files that must stay in sync
Undo-Redo Architecture Entity tree structure, undoable vs non-undoable, configuration patterns
Migration Guide Manifest changes and migration strategies
QML Integration Reactive models, mocks, and event system for C++/Qt
Generated Infrastructure - C++/Qt Database layer, repositories, and file organization details
Generated Infrastructure - Rust Database layer, repositories, and file organization details
Troubleshooting Common issues and how to fix them

New to Qleany? Start with the Quick Start Guide - C++/Qt or Quick Start Guide - Rust. Then return here for reference.

Screenshot


Is Qleany the Right Fit?

When Qleany Makes Sense

Data-centric applications that will grow in complexity over time. Think document editors, project management tools, creative applications, or anything where users manipulate structured data and expect undo/redo to work reliably. This applies equally to desktop and mobile — a note-taking app on Plasma Mobile has the same architectural needs as one on desktop Linux.

Complex CLI tools in Rust — tools like git that manage structured data, have multiple subcommands, and need consistent internal architecture. Qleany itself is built this way: type qleany -h to see a CLI interface backed by the same architecture that powers its Slint GUI.

Applications targeting multiple platforms — if you're building for desktop Linux and want to support Plasma Mobile or Ubuntu Touch with the same codebase, Qleany's generated backend works identically across all of them. Write your business logic once, swap UI frontends as needed.

Applications needing multiple Qt frontends — if you need QtQuick, QtWidgets (or any combination of them simultaneously), Qleany generates a ready-to-compile backend architecture that any of these frontends can consume. The generated controllers, repositories, and event system work identically regardless of which UI toolkit you choose.

Solo developers or small teams without established architectural patterns. Qt provides excellent widgets and signals, but little guidance on organizing a 30,000-line application (or I couldn't find it). Qleany gives you that structure immediately, with patterns validated through real-world use in Skribisto.

Projects that will grow incrementally — the manifest-driven approach means you can define a new entity, regenerate the architecture, and immediately have a working controller, repository, DTOs, and use cases. The consistency this brings across your codebase is hard to achieve manually.

When to Reconsider

For simple utilities or single-purpose tools, Qleany introduces more infrastructure than you need. If your application doesn't have complex entity relationships, doesn't need undo/redo, and won't grow significantly, a hand-written architecture may serve you better. Yet since you only have to fill a few blank spots, using Qleany can save you time.

If you're working with a team that already has established patterns, introducing Qleany means everyone needs to learn its conventions. The generated code is readable and follows clear patterns, but it represents a specific way of doing things. Discuss with your team before adopting it. Do not antagonize existing workflows. A more professional approach may be to present Qleany's patterns with some open-minded senior devs of your team. Even if they don't want to use Qleany - which is fairly expected - they may appreciate some of its ideas and adapt them to their existing architecture. They may even want to use Qleany for prototyping or side projects, or scaffold new subsystems of an existing project without disrupting the main architecture.

Qleany targets native applications. If you're building for the web, using Electron, this isn't the right tool. Similarly, if you need high-throughput server-side processing, the patterns here are optimized for user interaction, not request-per-second performance.

Special Considerations

If you are targeting Android/iOS with Flutter or React Native, the Rust as a backend option can be an interesting choice, but the C++/Qt generation is not. Any Rust backend can use UniFFI or other means to call Rust from nearly any frontend accepting FFI (SwiftUI, Kotlin, etc...)

You can also have a Rust backend and a C++/Qt frontend in the same codebase, using cxx-qt as a bridge.

The Practical Test

If your project matches the profile, start by generating the architecture for a small subset of your entities and spend time reading through the generated code. Understand how the controllers wire to use cases, how the event system propagates changes, how the undo commands work. This investment of a few hours will tell you whether the patterns feel natural to your way of thinking.

The "generate and disappear" philosophy means you're not locked in. If you decide halfway through that you'd prefer a different approach, the generated code is yours to modify or replace.


Why Qleany

I wrote Skribisto, a novel-writing application in Qt. Four times. In different languages. Each time, I hit the same wall: spaghetti code and structural dead-ends that made adding features painful and eventually impossible without rewriting half the codebase.

After the third rewrite, I studied architecture patterns seriously. Clean Architecture (Robert C. Martin) clicked — the separation of concerns, the dependency rules, the testability. But implementing it by hand meant writing the same boilerplate over and over: repositories, DTOs, use cases, controllers. So I wrote templates. The templates grew into a generator. The generator needed a manifest file.

Qleany v0 was Python/Jinja2 generating C++/Qt code following pure Clean Architecture. It worked, but the tradeoffs were hard to miss: a 17-entity project produced 1700+ files across 500 folders. Some of my early design choices were dubious in hindsight.

Qleany v1 is a ground-up rewrite in Rust, aiming to fix those problems while adopting a more robust and easier-to-maintain language. Less sophisticated, more pragmatic, architecture. It adopts Package by Feature (a.k.a. Vertical Slice Architecture) instead of strict layer separation — same Clean Architecture principles, but organized by what the code does rather than what layer it belongs to. The same manifest now generates both C++/Qt and Rust code.

This is the tool I needed when I started Skribisto. If it saves someone else from their fourth rewrite, it's done its job.


Target Platforms

Language Standard internal database Frontend Options
C++ C++20 / Qt6 SQLite QtQuick, QtWidgets
Rust Rust 2024 redb CLI, Slint

Supported deployment targets for C++/Qt:

  • Desktop Linux (KDE Plasma, GNOME, etc.)
  • Plasma Mobile
  • Ubuntu Touch
  • Windows, macOS (Qt's cross-platform support)

Supported deployment targets for Rust:

  • All the usual Rust targets (Linux, Windows, macOS, etc.)

The generated backend is platform-agnostic. Your business logic, repositories, and controllers work identically whether you're building a desktop app, a mobile app, or both from the same codebase. Only the UI layer differs.

Also, the internal database choice (SQLite for C++/Qt, redb for Rust) is abstracted behind repositories. You can swap out the database implementation if needed, though SQLite and redb are solid choices for most applications.

Rust frontend examples (working references):

I'm no web developer, and Tauri/React is not my forte. But if you want to build a web-based frontend with Rust backend generated by Qleany, this is a starting point.


Where to Get Qleany

Source Status
GitHub Releases See here
Cargo cargo install --git https://github.com/jacquetc/qleany qleany or cargo binstall qleany
PyPI (pip) with pipx pipx install qleany from Pypi

Or build from source (see below).


License

Qleany (the generator) is licensed under MPL-2.0. See the LICENSE file for details. It is compatible with both open source and proprietary projects.

Generated code: This license does not cover the code generated by Qleany. You are free to use, modify, and distribute generated code under any license of your choice, including proprietary licenses.

For more details, see this fine summary


Building and Running

Prerequisites

Building Qleany

git clone https://github.com/jacquetc/qleany
cd qleany
cargo build --release

Running the UI

cargo run --release

The Slint-based UI provides:

  • Form-based manifest editing
  • Entity and relationship management
  • Selective file generation
  • Code preview before writing

For more details, see the Quick Start Guide - C++/Qt or Quick Start Guide - Rust.

CLI Usage

# Show help
qleany -h


# Show an option help
qleany generate -h


# show the list of available documentation
qleany doc -h

# show all documentation
qleany doc

# new qleany.yaml manifest
qleany new --language cpp-qt (or rust)

# Generate all files
qleany generate

# Dry run (list files that would be generated without writing)
qleany generate --dry-run

# Dry run (list files that would be generated without writing)
qleany generate --dry-run entity MyEntity

# Generate to temp folder (recommended)
qleany generate --temp

# Generate specific feature
qleany generate feature my_feature_name

# List files that would be generated
qleany list

# List features that would be generated
qleany list features

Reference Implementation

Skribisto (develop branch) is a novel-writing application built with Qleany-generated C++/Qt code. It demonstrates:

  • Full entity hierarchy (Root → Work → Binder → BinderItem → Content)
  • Complex relationships (ordered children, many-to-many tags)
  • Feature orchestration (LoadWork, SaveWork with file format transformation)
  • Reactive QML UI with auto-updating models
  • Undo/redo across structural and content operations

Skribisto serves as both proof-of-concept and template source for C++/Qt generation.


Migration from v0

Qleany v0 (Python/Jinja2) generated pure Clean Architecture with strict layer separation. A 17-entity project produced 1700+ files across 500 folders. Yes, version "zero" is the first version, the prototype.

v1 generates Package by Feature with pragmatic organization. The same project produces ~600 files across ~80 folders with better discoverability. Its manifest version begins with version 2.

Breaking changes:

  • Manifest format changed (schema version 2)
  • Output structure reorganized by feature
  • Reactive models are new (list models, singles)

Bottom line: from v0 to v1, there is no automated migration path. You must regenerate from your manifest and manually port any custom code.

Starting from the newer version 2 of the manifest (i.e., Qleany v1), the new architecture offers a smoother transition to future versions, doing it automatically at load time, or using qleany upgrade.

See the Migration Guide for more details.


Contributing

Qleany is developed alongside Skribisto. The architecture is stable, but templates are being extracted and refined.

To contribute:

  1. Open an issue to discuss changes
  2. Ensure changes work for both Rust and C++/Qt
  3. Remember to sign off your commits (commit -s)

Please read the CONTRIBUTING.md file.

Support

GitHub Issues is the only support channel: github.com/jacquetc/qleany/issues

Qleany is a project licensed under MPL-2.0. It is actively used in Skribisto's development, among other projects from FernTech, so improvements flow from real-world needs. Bug reports and contributions are welcome.

FernTech offers professional support for Qleany.

AI use

Qleany is not an AI tool. It is a human-driven tool using templates and smart (I can hope) algorithms.

In this era where too much code comes from AI, and too much "slop" code, I feel that I must be honest with my use of these semi-smart tools. I am an IT professional for 14 years (started in 2011). I was Linux sysadmin, DevOps engineer, and now a senior C++ and Rust developer/tech lead/architect. I learned my trade before all this AI stuff. For me, LLMs are capricious smart tools. My take: never trust a LLM, always check the answers because they tend to trick you, LLMs never learn from their mistakes, unlike a human. It's a tool, not a crutch. [Ranting mode: off]

In Qleany, AI was used in only three cases:

  • basic auto-completion, thanks to the LLM integrated into JetBrains IDEs (especially in very repetitive patterns), less "magical" than GitHub Copilot, but still helpful.
  • English sentences in the documentation were smoothed with the AI, nothing more. And it helped to create tables with all these asterisks. I wrote this documentation.
  • The AI added some comments and inline documentation, especially in the C++ undo redo system. It was fun.

That's it. I honestly feel that Qleany is the work of a human being (me), not a machine.

About

Qleany is developed and maintained by FernTech.

Copyright (c) 2025-2026 FernTech Licensed under MPL-2.0

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

qleany-1.0.34-py3-none-win_amd64.whl (13.3 MB view details)

Uploaded Python 3Windows x86-64

qleany-1.0.34-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (15.1 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

qleany-1.0.34-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (14.4 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

qleany-1.0.34-py3-none-macosx_11_0_arm64.whl (12.4 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

qleany-1.0.34-py3-none-macosx_10_12_x86_64.whl (13.0 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

Details for the file qleany-1.0.34-py3-none-win_amd64.whl.

File metadata

  • Download URL: qleany-1.0.34-py3-none-win_amd64.whl
  • Upload date:
  • Size: 13.3 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: maturin/1.12.6

File hashes

Hashes for qleany-1.0.34-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 02b8a72cd50ae95c50faf507c6ac8fbf7aad7a93cbea71d2728b11c59f12f465
MD5 a2e1a6d1e94c73d6b13a12f7242cda06
BLAKE2b-256 d62e40874d231f13983a6af461767a6d79fb6dd67cc100b8ba3d3d6f0d3dbeb6

See more details on using hashes here.

File details

Details for the file qleany-1.0.34-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for qleany-1.0.34-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 dcc836ae9368de3a48c3447262bba0e3580887b613b091e3685d5400a729b46b
MD5 ee3c4b40fa2a4fb40d3f3a14dd23908b
BLAKE2b-256 afa82352cdefa94d4dba0bd4332d09deffbb800b154a5d32d7752d2ee41b0a13

See more details on using hashes here.

File details

Details for the file qleany-1.0.34-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for qleany-1.0.34-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 e0408ed862ccaac5e1ec7d830f136c264a485a17190ca2e2a9205e821022d533
MD5 1cef0c8d4c1080ea617a9b577447473f
BLAKE2b-256 d0bf5726eb6401e13c7fd1dea47e7d187aed2d24ef47ebc75273eb568a647845

See more details on using hashes here.

File details

Details for the file qleany-1.0.34-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for qleany-1.0.34-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 57c3d0940a0a209385bb1fd55425dc4dd76b540445629a010f26ccebeab28b23
MD5 61cf5358f9cda479bde80ef85f3d6574
BLAKE2b-256 987515f0874b7b36f3c1bc938a79a951e8556831e61981fd501dd8ef611a0882

See more details on using hashes here.

File details

Details for the file qleany-1.0.34-py3-none-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for qleany-1.0.34-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 12805bc1c81263089594f23cd45292a74174de1c39d1a73f651e60968cec4a85
MD5 113c61f77e028f0803a4b1350a81293f
BLAKE2b-256 bf1a30df1276dbcfadac0f0333b79b6f8cc7b260d948043af5840fc5194d2453

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page