Package: shalion-sqlmodel
SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness.Documentation:https://sqlmodel.tiangolo.comSource Code:https://github.com/tiangolo/sqlmodelSQLModel is a library for interacting withSQL databasesfrom Python code, with Python objects. It is designed to be intuitive, easy to use, highly compatible, and robust.SQLModelis based on Python type annotations, and powered byPydanticandSQLAlchemy.The key features are:Intuitive to write: Great editor support.Completioneverywhere. Less time debugging. Designed to be easy to use and learn. Less time reading docs.Easy to use: It has sensible defaults and does a lot of work underneath to simplify the code you write.Compatible: It is designed to be compatible withFastAPI, Pydantic, and SQLAlchemy.Extensible: You have all the power of SQLAlchemy and Pydantic underneath.Short: Minimize code duplication. A single type annotation does a lot of work. No need to duplicate models in SQLAlchemy and Pydantic.SQL Databases in FastAPISQLModelis designed to simplify interacting with SQL databases inFastAPIapplications, it was created by the sameauthor. 😁It combines SQLAlchemy and Pydantic and tries to simplify the code you write as much as possible, allowing you to reduce thecode duplication to a minimum, but while getting thebest developer experiencepossible.SQLModelis, in fact, a thin layer on top ofPydanticandSQLAlchemy, carefully designed to be compatible with both.RequirementsA recent and currently supported version of Python (right now,Python supports versions 3.6 and above).AsSQLModelis based onPydanticandSQLAlchemy, it requires them. They will be automatically installed when you install SQLModel.Installation$pipinstallsqlmodel---> 100%Successfully installed sqlmodelExampleFor an introduction to databases, SQL, and everything else, see theSQLModel documentation.Here's a quick example. ✨A SQL TableImagine you have a SQL table calledherowith:idnamesecret_nameageAnd you want it to have this data:idnamesecret_nameage1DeadpondDive Wilsonnull2Spider-BoyPedro Parqueadornull3Rusty-ManTommy Sharp48Create a SQLModel ModelThen you could create aSQLModelmodel like this:fromtypingimportOptionalfromsqlmodelimportField,SQLModelclassHero(SQLModel,table=True):id:Optional[int]=Field(default=None,primary_key=True)name:strsecret_name:strage:Optional[int]=NoneThat classHerois aSQLModelmodel, the equivalent of a SQL table in Python code.And each of those class attributes is equivalent to eachtable column.Create RowsThen you couldcreate each rowof the table as aninstanceof the model:hero_1=Hero(name="Deadpond",secret_name="Dive Wilson")hero_2=Hero(name="Spider-Boy",secret_name="Pedro Parqueador")hero_3=Hero(name="Rusty-Man",secret_name="Tommy Sharp",age=48)This way, you can use conventional Python code withclassesandinstancesthat representtablesandrows, and that way communicate with theSQL database.Editor SupportEverything is designed for you to get the best developer experience possible, with the best editor support.Includingautocompletion:Andinline errors:Write to the DatabaseYou can learn a lot more aboutSQLModelby quickly following thetutorial, but if you need a taste right now of how to put all that together and save to the database, you can do this:fromtypingimportOptionalfromsqlmodelimportField,Session,SQLModel,create_engineclassHero(SQLModel,table=True):id:Optional[int]=Field(default=None,primary_key=True)name:strsecret_name:strage:Optional[int]=Nonehero_1=Hero(name="Deadpond",secret_name="Dive Wilson")hero_2=Hero(name="Spider-Boy",secret_name="Pedro Parqueador")hero_3=Hero(name="Rusty-Man",secret_name="Tommy Sharp",age=48)engine=create_engine("sqlite:///database.db")SQLModel.metadata.create_all(engine)withSession(engine)assession:session.add(hero_1)session.add(hero_2)session.add(hero_3)session.commit()That will save aSQLitedatabase with the 3 heroes.Select from the DatabaseThen you could write queries to select from that same database, for example with:fromtypingimportOptionalfromsqlmodelimportField,Session,SQLModel,create_engine,selectclassHero(SQLModel,table=True):id:Optional[int]=Field(default=None,primary_key=True)name:strsecret_name:strage:Optional[int]=Noneengine=create_engine("sqlite:///database.db")withSession(engine)assession:statement=select(Hero).where(Hero.name=="Spider-Boy")hero=session.exec(statement).first()print(hero)Editor Support EverywhereSQLModelwas carefully designed to give you the best developer experience and editor support,even after selecting datafrom the database:SQLAlchemy and PydanticThat classHerois aSQLModelmodel.But at the same time, ✨ it is aSQLAlchemymodel ✨. So, you can combine it and use it with other SQLAlchemy models, or you could easily migrate applications with SQLAlchemy toSQLModel.And at the same time, ✨ it is also aPydanticmodel ✨. You can use inheritance with it to define all yourdata modelswhile avoiding code duplication. That makes it very easy to use withFastAPI.LicenseThis project is licensed under the terms of theMIT license.