Merge pull request #1 from testdrivenio/updates

add sqlmodel and alembic

Author: mjhea0

.gitignore

@@ -1,4 +1,2 @@
 __pycache__
 env
-htmlcov
-.coverage

README.md

@@ -2,7 +2,11 @@
 
 Sample FastAPI project that uses async SQLAlchemy, SQLModel, Postgres, Alembic, and Docker.
 
-## Getting Started
+## Want to learn how to build this?
+
+Check out the [post](https://testdriven.io/blog/fastapi-sqlmodel/).
+
+## Want to use this project?
 
 ```sh
 $ docker-compose up -d --build

project/app/db.py

@@ -8,10 +8,10 @@
 
 DATABASE_URL = os.environ.get("DATABASE_URL")
 
-engine = create_async_engine(DATABASE_URL, echo=True)
+engine = create_async_engine(DATABASE_URL, echo=True, future=True)
 
 
-async def create_db_and_tables():
+async def init_db():
     async with engine.begin() as conn:
         # await conn.run_sync(SQLModel.metadata.drop_all)
         await conn.run_sync(SQLModel.metadata.create_all)

project/app/main.py

@@ -1,5 +1,5 @@
 from fastapi import Depends, FastAPI
-from sqlalchemy import select
+from sqlalchemy.future import select
 from sqlalchemy.ext.asyncio import AsyncSession
 
 from app.db import get_session
@@ -25,4 +25,5 @@ async def add_song(song: SongCreate, session: AsyncSession = Depends(get_session
     song = Song(name=song.name, artist=song.artist, year=song.year)
     session.add(song)
     await session.commit()
+    await session.refresh(song)
     return song

project/app/models.py

@@ -1,10 +1,12 @@
+from typing import Optional
+
 from sqlmodel import SQLModel, Field
 
 
 class SongBase(SQLModel):
     name: str
     artist: str
-    year: str
+    year: Optional[int] = None
 
 
 class Song(SongBase, table=True):

project/migrations/env.py

@@ -22,7 +22,6 @@
 # for 'autogenerate' support
 # from myapp import mymodel
 # target_metadata = mymodel.Base.metadata
-target_metadata = None
 target_metadata = SQLModel.metadata
 
 # other values from the config, defined by the needs of env.py,

project/migrations/versions/94598cb1fa7b_add_year.py renamed to project/migrations/versions/53754b2c08a4_add_year.py

@@ -1,8 +1,8 @@
-"""add_year
+"""add year
 
-Revision ID: 94598cb1fa7b
-Revises: bf9bd33c0c06
-Create Date: 2021-09-08 23:27:31.948299
+Revision ID: 53754b2c08a4
+Revises: f9c634db477d
+Create Date: 2021-09-10 00:52:38.668620
 
 """
 from alembic import op
@@ -11,15 +11,15 @@
 
 
 # revision identifiers, used by Alembic.
-revision = '94598cb1fa7b'
-down_revision = 'bf9bd33c0c06'
+revision = '53754b2c08a4'
+down_revision = 'f9c634db477d'
 branch_labels = None
 depends_on = None
 
 
 def upgrade():
     # ### commands auto generated by Alembic - please adjust! ###
-    op.add_column('song', sa.Column('year', sqlmodel.sql.sqltypes.AutoString(), nullable=False))
+    op.add_column('song', sa.Column('year', sa.Integer(), nullable=True))
     op.create_index(op.f('ix_song_year'), 'song', ['year'], unique=False)
     # ### end Alembic commands ###
 

project/migrations/versions/bf9bd33c0c06_init.py renamed to project/migrations/versions/f9c634db477d_init.py

@@ -1,8 +1,8 @@
 """init
 
-Revision ID: bf9bd33c0c06
+Revision ID: f9c634db477d
 Revises: 
-Create Date: 2021-09-08 23:27:12.444844
+Create Date: 2021-09-10 00:24:32.718895
 
 """
 from alembic import op
@@ -11,7 +11,7 @@
 
 
 # revision identifiers, used by Alembic.
-revision = 'bf9bd33c0c06'
+revision = 'f9c634db477d'
 down_revision = None
 branch_labels = None
 depends_on = None

project/requirements.txt

@@ -1,7 +1,5 @@
 alembic==1.7.1
 asyncpg==0.24.0
 fastapi==0.68.1
-SQLAlchemy==1.4.23
 sqlmodel==0.0.4
-typer==0.4.0
 uvicorn==0.15.0