Metadata-Version: 2.4
Name: litestar-start
Version: 0.1.0b3
Summary: Interactive CLI to scaffold fullstack projects with modular choices
Project-URL: Documentation, https://github.com/Harshal6927/litestar-start#readme
Project-URL: Issues, https://github.com/Harshal6927/litestar-start/issues
Project-URL: Source, https://github.com/Harshal6927/litestar-start
Author-email: Harshal Laheri <harshal@harshallaheri.me>
License-Expression: MIT
License-File: LICENSE
Keywords: cli,fullstack,generator,litestar,scaffolding,template
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Code Generators
Requires-Python: >=3.13
Requires-Dist: jinja2>=3.1.6
Requires-Dist: msgspec>=0.20.0
Requires-Dist: questionary>=2.1.1
Requires-Dist: rich>=14.2.0
Description-Content-Type: text/markdown

# Litestar Start

Interactive CLI to scaffold fullstack [Litestar](https://litestar.dev) projects with modular choices.

## Features

- **Interactive prompts** — guided setup with [questionary](https://questionary.readthedocs.io/)
- **Database support** — PostgreSQL, MySQL, or SQLite via AdvancedAlchemy
- **Memory stores** — Redis or Valkey for caching / background tasks
- **Plugin system** — modular plugins that add functionality:
  - **AdvancedAlchemy** — SQLAlchemy ORM integration with models, services, and dependencies
  - **Litestar SAQ** — background task queue powered by SAQ (requires a memory store)
  - **Litestar Vite** — frontend asset bundling with Vite
  - **Litestar Granian** — high-performance Granian ASGI server
- **Docker** — optional Dockerfile and `docker-compose.infra.yml` for local development
- **Post-generation setup** — automatic `git init`, `uv sync`, Docker infrastructure startup, and import sorting

## Requirements

- Python 3.13+
- [uv](https://docs.astral.sh/uv/) (used for dependency management in generated projects)

## Installation

```bash
uvx litestar-start
```

Or install globally:

```bash
uv tool install litestar-start
```

## Usage

Run the CLI and follow the interactive prompts:

```bash
litestar-start
```

You will be asked to:

1. Enter a project name
2. Select a database (PostgreSQL, SQLite, MySQL, or None)
3. Select a memory store (Redis, Valkey, or None)
4. Choose plugins (based on your database/store choices)
5. Configure Docker options
6. Confirm and generate

The generated project includes a working Litestar application with your selected options pre-configured.

## Development

```bash
git clone https://github.com/Harshal6927/litestar-start.git
cd litestar-start
uv sync
```

Run tests:

```bash
pytest
```

Run linters:

```bash
make lint
```

## License

MIT
