Metadata-Version: 2.4
Name: rapidkit-core
Version: 0.3.3rc1
Summary: Community-built rapid automation toolkit for makers who ship with heart
License: MIT
License-File: LICENSE
Keywords: scaffolding,boilerplate,fastapi,codegen,devtools
Author: RapidKit Team
Author-email: team@getrapidkit.com
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Code Generators
Requires-Dist: black (>=25.9.0,<26.0.0)
Requires-Dist: click (>=8.3,<8.4)
Requires-Dist: cryptography (>=46.0.2,<47.0.0)
Requires-Dist: email-validator (>=2.1,<3.0)
Requires-Dist: fastapi (>=0.119.0,<1.0.0)
Requires-Dist: jinja2 (>=3.1.6,<4.0.0)
Requires-Dist: jsonschema (>=4.25.1,<5.0.0)
Requires-Dist: packaging (>=25.0,<26.0)
Requires-Dist: pydantic (>=2.12.2)
Requires-Dist: pydantic-settings (>=2.11,<3.0)
Requires-Dist: pygithub (>=2.7.0,<3.0.0)
Requires-Dist: pynacl (>=1.5.0,<2.0.0)
Requires-Dist: pyyaml (>=6.0.3,<7.0.0)
Requires-Dist: requests (>=2.32.5,<3.0.0)
Requires-Dist: rich (>=14.2.0,<15.0.0)
Requires-Dist: starlette (>=0.49.1,<0.50)
Requires-Dist: tabulate (>=0.9.0,<0.10.0)
Requires-Dist: typer (>=0.19,<0.20)
Requires-Dist: types-requests (>=2.32.4.20250913,<3.0.0.0)
Requires-Dist: uvicorn[standard] (>=0.37.0)
Requires-Dist: yamllint (>=1.37.1,<2.0.0)
Project-URL: Documentation, https://www.getrapidkit.com/docs
Project-URL: Homepage, https://www.getrapidkit.com/
Project-URL: Repository, https://github.com/getrapidkit/rapidkit-core
Description-Content-Type: text/markdown

# RapidKit Core

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python](https://img.shields.io/badge/Python-3.10%2B-blue.svg)](https://www.python.org/)

RapidKit Core is the open-source RapidKit engine and CLI for scaffolding, operating, and evolving
production-ready backend projects.

- Package: `rapidkit-core`
- CLI: `rapidkit`
- Website: https://www.getrapidkit.com/
- Docs: https://www.getrapidkit.com/docs
- Repository: https://github.com/getrapidkit/rapidkit-core
- Issues: https://github.com/getrapidkit/rapidkit-core/issues
- Discussions: https://github.com/getrapidkit/rapidkit-core/discussions

## Useful tools

- RapidKit npm CLI: https://github.com/getrapidkit/rapidkit-npm
- npm package: https://www.npmjs.com/package/rapidkit
- RapidKit VS Code Extension: https://github.com/getrapidkit/rapidkit-vscode
- VS Code Marketplace: https://marketplace.visualstudio.com/items?itemName=rapidkit.rapidkit-vscode

## What you get

- Production-grade scaffolding for FastAPI and NestJS
- Consistent module lifecycle: add, remove, upgrade, diff, reconcile, rollback
- Project-aware commands for local development and CI workflows
- Standardized project structure with `.rapidkit/` metadata

## Install

```bash
# Recommended: isolated CLI
pipx install rapidkit-core

# Or: in the current interpreter
python -m pip install -U rapidkit-core

rapidkit --version
rapidkit --help
```

## Quick start

```bash
# Interactive wizard
rapidkit create

# Or: non-interactive
rapidkit create project fastapi.standard my-api

cd my-api
rapidkit init
rapidkit dev
```

## CLI surface

### Global commands

- `rapidkit version`, `rapidkit project`, `rapidkit list`, `rapidkit info`, `rapidkit commands`
- `rapidkit create`, `rapidkit add`, `rapidkit modules`, `rapidkit frameworks`
- `rapidkit upgrade`, `rapidkit diff`, `rapidkit merge`, `rapidkit optimize`
- `rapidkit doctor`, `rapidkit license`, `rapidkit checkpoint`, `rapidkit snapshot`
- `rapidkit reconcile`, `rapidkit rollback`, `rapidkit uninstall`
- `rapidkit --tui`, `rapidkit --version`, `rapidkit -v`

### Project commands

Inside a generated RapidKit project:

- `rapidkit init`
- `rapidkit dev`
- `rapidkit start`
- `rapidkit build`
- `rapidkit test`
- `rapidkit lint`
- `rapidkit format`
- `rapidkit help`

### Common examples

```bash
rapidkit create project
rapidkit create project fastapi.standard my-api
rapidkit create project nestjs.standard my-api
rapidkit create project fastapi.standard my-api --output /path/to/workspace

cd my-api && rapidkit init
rapidkit dev
rapidkit add module auth
rapidkit modules list
```

## Pre-releases (RC)

Pre-releases are published as Python pre-releases and may be marked as pre-releases on GitHub.

- Releases: https://github.com/getrapidkit/rapidkit-core/releases

```bash
pipx install --pip-args="--pre" rapidkit-core
# or
python -m pip install --pre -U rapidkit-core
```

## Contributing

- Start here: https://github.com/getrapidkit/rapidkit-core/tree/main/docs/contributing
- Bug reports: https://github.com/getrapidkit/rapidkit-core/issues
- Ideas and Q&A: https://github.com/getrapidkit/rapidkit-core/discussions

## License

MIT — see https://github.com/getrapidkit/rapidkit-core/blob/main/LICENSE

