diff --git a/README.md b/README.md index f70e4f1..c8978fc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- FastCRUD written in white with a drawing of a gear and inside this gear a bolt. + FastCRUD written in white with a drawing of a gear and inside this gear a bolt.

@@ -70,16 +70,20 @@ Below are examples demonstrating both approaches:

Using crud_router for Automatic Endpoint Creation

+> \[!WARNING\] +> For now, your primary column must be named `id` or automatic endpoint creation will not work. + Here's a quick example to get you started:

Define Your Model and Schema

```python from sqlalchemy import Column, Integer, String -from sqlalchemy.orm import declarative_base +from sqlalchemy.orm import DeclarativeBase from pydantic import BaseModel -Base = declarative_base() +class Base(DeclarativeBase): + pass class Item(Base): __tablename__ = 'items' diff --git a/assets/fastcrud_with_background.png b/assets/fastcrud_with_background.png new file mode 100644 index 0000000..98eadd4 Binary files /dev/null and b/assets/fastcrud_with_background.png differ diff --git a/pyproject.toml b/pyproject.toml index 7cbdb06..0a94fd2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "fastcrud" -version = "0.1.0" +version = "0.1.3" description = "FastCRUD is a Python package for FastAPI, offering robust async CRUD operations and flexible endpoint creation utilities." authors = ["Igor Benav "] license = "MIT"