Configuration

python manage.py generate_fastapi [apps...] [options]

from django_cfg.modules.django_fastapi import FastAPIConfig
 
config = FastAPIConfig(
    # Core
    enabled=True,
    output_dir="src/orm/",
    format="sqlmodel",
 
    # Generation
    include_crud=True,
    include_schemas=True,
    include_database_config=True,
    include_alembic=False,
    async_mode=True,
 
    # App Selection
    apps=["users", "products", "orders"],
    exclude_apps=["admin", "auth"],
    exclude_models=["users.Session"],
 
    # PostgreSQL
    use_jsonb=True,
    use_array_fields=True,
    use_uuid_type=True,
 
    # Naming
    schema_suffix="Schema",
    repository_suffix="Repository",
    add_docstrings=True,
    add_type_hints=True,
)

[
    "admin", "auth", "contenttypes", "sessions",
    "messages", "staticfiles", "sites",
    "django_celery_beat", "django_celery_results"
]

config = FastAPIConfig(
    output_dir="api/models/",
    include_crud=False,
    include_database_config=False,
)

config = FastAPIConfig(
    output_dir="src/orm/",
    apps=["core", "users", "products", "orders"],
    exclude_models=["users.TempSession"],
    use_jsonb=True,
    use_array_fields=True,
    async_mode=True,
    add_docstrings=True,
)

# Disable PostgreSQL-specific features
config = FastAPIConfig(
    use_jsonb=False,
    use_array_fields=False,
    use_uuid_type=False,
)

config = FastAPIConfig(
    async_mode=False,  # Generates sync Session instead of AsyncSession
)

DATABASE_URL=postgresql+asyncpg://user:pass@localhost:5432/mydb

orm:
	python manage.py generate_fastapi
 
migrate: ## Run migrations and regenerate ORM
	python manage.py migrate
	python manage.py generate_fastapi

# .github/workflows/orm.yml
on:
  push:
    paths:
      - '**/models.py'
 
jobs:
  generate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: python manage.py generate_fastapi
      - run: |
          git add orm/
          git commit -m "chore: regenerate ORM" || exit 0
          git push