Skip to content

Commit 84c23de

Browse files
authored
Merge pull request #537 from lbedner/readme-update
README Update
2 parents 88b2d35 + da180bb commit 84c23de

7 files changed

Lines changed: 26 additions & 15 deletions

File tree

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Each generated project includes:
3232

3333
## Installation
3434

35-
**Current Version**: 0.6.2
35+
**Current Version**: 0.6.3-rc1
3636

3737
```bash
3838
pip install aegis-stack

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,15 @@
66
[![CI](https://github.com/lbedner/aegis-stack/workflows/CI/badge.svg)](https://github.com/lbedner/aegis-stack/actions/workflows/ci.yml)
77
[![Documentation](https://github.com/lbedner/aegis-stack/workflows/Deploy%20Documentation/badge.svg)](https://github.com/lbedner/aegis-stack/actions/workflows/docs.yml)
88
[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
9-
[![Commits per Month](https://img.shields.io/github/commit-activity/m/lbedner/aegis-stack)](https://github.com/lbedner/aegis-stack/commits)
10-
[![Total Commits](https://img.shields.io/github/commit-activity/t/lbedner/aegis-stack)](https://github.com/lbedner/aegis-stack/commits)
9+
[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/copier-org/copier)
10+
1111
[![Monthly Downloads](https://img.shields.io/pypi/dm/aegis-stack)](https://pypi.org/project/aegis-stack/)
1212
[![Total Downloads](https://static.pepy.tech/badge/aegis-stack)](https://pepy.tech/project/aegis-stack)
13-
[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/copier-org/copier)
13+
[![PyPI - Top 10% 2026](https://img.shields.io/badge/PyPI-Top_10%25_2026-2ea043)](https://clickpy.clickhouse.com/dashboard/aegis-stack?min_date=2026-01-01&max_date=2026-12-31)
14+
15+
[![Commits per Month](https://img.shields.io/github/commit-activity/m/lbedner/aegis-stack)](https://github.com/lbedner/aegis-stack/commits)
16+
[![Total Commits](https://img.shields.io/github/commit-activity/t/lbedner/aegis-stack)](https://github.com/lbedner/aegis-stack/commits)
17+
[![Last Commit](https://img.shields.io/github/last-commit/lbedner/aegis-stack)](https://github.com/lbedner/aegis-stack/commits)
1418

1519
You need to ship reliable software, but management only gave you 2 weeks.
1620

@@ -20,7 +24,7 @@ No time for health checks, proper testing, or clean architecture. Just enough ti
2024

2125
![Aegis Stack Quick Start Demo](docs/images/aegis-demo.gif)
2226

23-
Aegis Stack is a system for creating and evolving modular Python applications over time, built on tools you already know.
27+
A production-ready FastAPI platform with modular components and a built-in control plane.
2428

2529
## Prerequisites
2630

@@ -40,7 +44,7 @@ uvx aegis-stack init user-app --services auth
4044
uvx aegis-stack init task-processor --components scheduler,worker
4145

4246
# Start building
43-
cd my-api && uv sync && cp .env.example .env && make serve
47+
cd my-api && make serve
4448
```
4549

4650
**Installation alternatives:** See the [Installation Guide](https://lbedner.github.io/aegis-stack/installation/) for `uv tool install`, `pip install`, and development setup.
@@ -119,7 +123,7 @@ Most starters lock you in at `init`. Aegis Stack doesn't. See **[Evolving Your S
119123
- **Database** → Postgres / SQLite
120124
- **Cache/Queue** → Redis
121125
- **Scheduler** → APScheduler
122-
- **Worker** → Arq / Taskiq
126+
- **Worker** → Arq / Taskiq / Dramatiq
123127

124128
**Services** (business logic)
125129

@@ -131,10 +135,12 @@ Most starters lock you in at `init`. Aegis Stack doesn't. See **[Evolving Your S
131135

132136
## Learn More
133137

138+
- **[Overseer](https://lbedner.github.io/aegis-stack/overseer/)** - Built-in system dashboard
139+
- **[Deployment](https://lbedner.github.io/aegis-stack/deployment/)** - Deploy with backups, rollback, and health checks
134140
- **[CLI Reference](https://lbedner.github.io/aegis-stack/cli-reference/)** - Complete command reference
135-
- **[About](https://lbedner.github.io/aegis-stack/about/)** - The philosophy and vision behind Aegis Stack
136141
- **[Evolving Your Stack](https://lbedner.github.io/aegis-stack/evolving-your-stack/)** - Add/remove components as needs change
137142
- **[Technology Stack](https://lbedner.github.io/aegis-stack/technology/)** - Battle-tested technology choices
143+
- **[About](https://lbedner.github.io/aegis-stack/about/)** - The philosophy and vision behind Aegis Stack
138144

139145
## For The Veterans
140146

aegis/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
Aegis Stack CLI - Component generation and project management tools.
33
"""
44

5-
__version__ = "0.6.2"
5+
__version__ = "0.6.3rc1"

aegis/core/copier_manager.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -319,10 +319,15 @@ def generate_with_copier(
319319
print(f"Warning: Failed to initialize git repository: {e}")
320320
print("Run 'git init && git add . && git commit' manually")
321321

322-
# Show docs/GitHub links
322+
# Show docs/star links
323323
typer.echo()
324324
typer.secho("Docs: https://lbedner.github.io/aegis-stack", dim=True)
325-
typer.secho("GitHub: https://github.com/lbedner/aegis-stack", dim=True)
325+
typer.echo()
326+
star = typer.style("\u2605", fg=typer.colors.BRIGHT_YELLOW, bold=True)
327+
typer.echo(
328+
f"{star} If Aegis Stack made your life easier, consider leaving a star:\n"
329+
" https://github.com/lbedner/aegis-stack"
330+
)
326331

327332
# CRITICAL: Fix _src_path in .copier-answers.yml for future updates to work
328333
#

copier.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# - Update support
77

88
_min_copier_version: "9.0.0"
9-
_version: "0.6.2"
9+
_version: "0.6.3rc1"
1010

1111
# IMPORTANT: Template content is in subdirectory
1212
# This allows the template to be recognized as git-tracked (aegis-stack repo root has .git)

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[project]
22
name = "aegis-stack"
3-
version = "0.6.2"
4-
description = "A production-ready Python foundation for builders who refuse to wait. Try: uvx aegis-stack init my-project"
3+
version = "0.6.3rc1"
4+
description = "A production-ready FastAPI platform with modular components and a built-in control plane. Try: uvx aegis-stack init my-project"
55
readme = "README.md"
66
requires-python = ">=3.11,<3.15"
77
license = { text = "MIT" }

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)