File: index.rst

package info (click to toggle)
python-advanced-alchemy 1.8.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,904 kB
  • sloc: python: 36,227; makefile: 153; sh: 4
file content (53 lines) | stat: -rw-r--r-- 1,273 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
=====
Usage
=====

This guide demonstrates building a complete blog system using Advanced Alchemy's features. We'll create a system that supports:

- Posts with tags and slugs
- Tag management with automatic deduplication
- Efficient querying and pagination
- Type-safe database operations
- Schema validation and transformation

.. toctree::
    :maxdepth: 2
    :caption: Core Features

    modeling
    repositories
    services
    types
    cli
    database_seeding

.. toctree::
    :maxdepth: 2
    :caption: Framework Integration

    frameworks/litestar
    frameworks/flask
    frameworks/fastapi

The guide follows a practical approach:

1. **Modeling**: Define SQLAlchemy models with Advanced Alchemy's enhanced base classes
2. **Repositories**: Implement type-safe database operations using repositories
3. **Services**: Build business logic with automatic schema validation
4. **Framework Integration**: Integrate with Litestar and FastAPI

Each section includes:

- Concepts and usage overview
- Complete code examples
- Best practices
- Performance considerations
- Error handling strategies

Prerequisites
-------------

- Python 3.9+
- SQLAlchemy 2.0+
- Basic understanding of SQLAlchemy and async programming
- Basic understanding of Pydantic or Msgspec