# coodie

**The modern Pydantic-based ODM for Cassandra & ScyllaDB**

```{include} ../../README.md
:start-after: <!-- start-tagline -->
:end-before: <!-- end-tagline -->
```

## ✨ Feature Highlights

```{include} ../../README.md
:start-after: <!-- start-features -->
:end-before: <!-- end-features -->
```

## 📦 Installation

```{include} ../../README.md
:start-after: <!-- start-installation -->
:end-before: <!-- end-installation -->
```

## 🚀 Quick Start

```{include} ../../README.md
:start-after: <!-- start-quickstart -->
:end-before: <!-- end-quickstart -->
```

## 🔍 How Does coodie Compare?

```{include} ../../README.md
:start-after: <!-- start-comparison -->
:end-before: <!-- end-comparison -->
```

```{toctree}
:caption: Getting Started
:maxdepth: 2
:hidden:

installation
quickstart
```

```{toctree}
:caption: User Guide
:maxdepth: 2
:hidden:

guide/defining-documents
guide/field-types
guide/keys-and-indexes
guide/crud
guide/querying
guide/filtering
guide/user-defined-types
guide/collections
guide/counters
guide/ttl
guide/lwt
guide/batch-operations
guide/sync-vs-async
guide/drivers
guide/encryption
guide/schema-management
guide/exceptions
guide/recipes
guide/integrations
guide/benchmarks
```

```{toctree}
:caption: Migration
:maxdepth: 2
:hidden:

migration/from-cqlengine
migration/argus-example
```

```{toctree}
:caption: API Reference
:maxdepth: 2
:hidden:

api/document
api/queryset
api/fields
api/types
api/usertype
api/drivers
api/exceptions
api/results
api/batch
```

```{toctree}
:caption: Reference
:maxdepth: 2
:hidden:

usage
```

```{toctree}
:caption: Project Info
:maxdepth: 2
:hidden:

changelog
contributing
```