sqlmodelgenerator 0.1.0

CLI tool to generate SQLModel models from a Postgres database via SQLAlchemy introspection.

SQLModelGenerator

SQLModelGenerator is a CLI tool that automatically generates SQLModel models (including enums) directly from a Postgres database via SQLAlchemy introspection.

---

Features

• 🚀 Automatic model & enum generation from your live Postgres database
• ⚙️ Configurable: exclusions, naming rules, type overrides, and more
• 🗄️ Postgres support: arrays, JSONB, enums, relationships, and more
• 🔗 Relationship inference: detects and generates foreign key relationships
• 🖥️ CLI interface: built with Typer
• 👐 Open-source & commercial friendly: MIT license, use for any purpose

---

Installation

From PyPI (recommended):

pip install sqlmodelgenerator

For local development:

python -m venv .venv
.venv/Scripts/activate  # On Windows
# Or: source .venv/bin/activate  # On macOS/Linux
pip install -e .[dev]

---

Usage

Place a config file named sqlmodelgenerator.yaml, sqlmodelgenerator.yml, or sqlmodelgenerator.toml in your project root, or specify one with --config.

# With default config file in current directory
sqlmodelgenerator generate
sqlmodelgenerator inspect

# Or specify a config file
sqlmodelgenerator generate --config path/to/config.yaml
sqlmodelgenerator inspect --config path/to/config.yaml

---

Configuration

Supported config formats: YAML or TOML. Example:

database_url: postgresql://user:pass@localhost:5432/mydb
output_dir: models
enum_output_path: enums
exclude_tables: [alembic_version]
exclude_columns: []
field_type_overrides: {}
relationship_mode: full
cleanup_old_files: true

See example.sqlmodelgenerator.yaml or example.sqlmodelgenerator.toml for all options.

---

Example Output

# models/user.py
from sqlmodel import SQLModel, Field, Relationship
from enums.user_status import UserStatus
from typing import Optional

class User(SQLModel, table=True):
    id: int = Field(primary_key=True)
    name: str
    status: UserStatus
    profile_id: Optional[int] = Field(default=None, foreign_key="profile.id")
    profile: Optional[Profile] = Relationship(back_populates="user")

---

Development & Testing

• All tests are in the tests/ directory.
• Run tests: pytest
• Coverage: pytest --cov=src/sqlmodelgenerator
• Linting: flake8 src/ tests/
• Type checking: mypy src/ tests/
• Formatting: black src/ tests/

---

Contributing

We welcome contributions of all kinds! To get started:

1. Fork the repository and create your branch from main.
2. Install dependencies:

   python -m venv .venv
   .venv/Scripts/activate  # On Windows
   # Or: source .venv/bin/activate  # On macOS/Linux
   pip install -e .[dev]
   

3. Write tests for your changes (see tests/ directory).
4. Lint and format your code:

   black src/ tests/
   flake8 src/ tests/
   mypy src/ tests/
   

5. Open a pull request with a clear description of your changes.

Code style:

• Follows Black formatting
• Linting with Flake8
• Type checking with mypy

---

Community & Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Contact: [e-mail]

If you have questions, ideas, or need help, open an issue or start a discussion!

---

License

MIT License — free for personal, open-source, or commercial use. See LICENSE.

---

Developed by Finatic.dev — Contributions welcome!