Merge pull request #1 from seapagan/add-sqlite-option

add option to use SQLite instead of PostgreSQL

Author: seapagan

.gitignore

@@ -207,3 +207,4 @@ cython_debug/
 # End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,linux,python
 
 # Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
+test.db

README.md

@@ -4,6 +4,7 @@
 - [Installation](#installation)
 - [Usage](#usage)
   - [Local Postgres server using Docker](#local-postgres-server-using-docker)
+  - [Use SQLite instead of PostgreSQL](#use-sqlite-instead-of-postgresql)
 - [License](#license)
 
 ## Introduction
@@ -84,6 +85,17 @@ docker exec -it postgres psql -U postgres
 
 This will allow you to edit or delete the database or records.
 
+### Use SQLite instead of PostgreSQL
+
+For testing purposes, you can also use SQLite instead of PostgreSQL. To do so,
+open the [dp.py](db.py) file and comment out the PostgreSQL database in the
+`DATABASE_URL` environment variable and uncomment the SQLite database.
+
+```python
+# DATABASE_URL = "postgresql+asyncpg://postgres:postgres@localhost/postgres"
+DATABASE_URL = "sqlite+aiosqlite:///./test.db"
+```
+
 ## License
 
 This project is licensed under the terms of the MIT license.

db.py

@@ -3,6 +3,10 @@
 from sqlalchemy.orm import declarative_base
 
 DATABASE_URL = "postgresql+asyncpg://postgres:postgres@localhost/postgres"
+# DATABASE_URL = "sqlite+aiosqlite:///./test.db"
+# Note that (as far as I can tell from the docs and searching) there is no need
+# to add 'check_same_thread=False' to the sqlite connection string, as
+# SQLAlchemy version 1.4+ will automatically add it for you when using SQLite.
 
 engine = create_async_engine(DATABASE_URL, echo=False)
 Base = declarative_base()

poetry.lock

@@ -12,6 +12,7 @@ fastapi = "^0.97.0"
 asyncpg = "^0.27.0"
 sqlalchemy = {extras = ["asyncio"], version = "^2.0.16"}
 uvicorn = {extras = ["standard"], version = "^0.22.0"}
+aiosqlite = "^0.19.0"
 
 [tool.poetry.group.dev.dependencies]
 # linting and formatting tools