CSG-1065: Update Comet API for more Robust Database backend

README.md

@@ -4,13 +4,14 @@ The goal of this project is to provide a Python-based starter API, which comes p
 
 - Platform: Python
 - Web Framework: Fast API
-- Database: PostgreSQL (coming soon)
-- ORM: SQLAlchemy (coming soon)
+- Database: SQLite
+- ORM: SQLAlchemy, Alembic
+- Data Validation: Pydantic
 - Unit Testing: PyTest and unittest (coming soon)
 - Code Analysis: Ruff (coming soon)
 - Code Formatting: Ruff (coming soon)
 - Authentication support: JWT (coming soon)
-- Documentation: ReDoc (coming soon)
+- Documentation: Swagger and ReDoc
 
 ## Table of Contents
 
@@ -33,7 +34,13 @@ source venv/bin/activate
 pip install -r requirements.txt
 ```
 
-3. To start the app, run the following:
+3. To prepare your environment, add a file called `.env` to the `comet-api` directory. Copy and paste the template below and replace the placeholder values with your own:
+
+```
+DATABASE_URL=[SOME_URL] # Ex: 'sqlite:///./db.sqlite3'
+```
+
+4. To start the app, run the following:
 
 ```sh
 uvicorn app.main:app --reload --host=0.0.0.0 --port=5000

alembic.ini

@@ -0,0 +1,110 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = alembic
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python-dateutil library that can be
+# installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to dateutil.tz.gettz()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to alembic/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:alembic/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url =
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

alembic/README

@@ -0,0 +1 @@
+Generic single-database configuration.

alembic/env.py

@@ -0,0 +1,85 @@
+from logging.config import fileConfig
+
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+
+from alembic import context
+
+from app.config import settings
+from app.spacecraft.models import DBSpacecraft
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# this will overwrite the ini-file sqlalchemy.url path
+# with the path given in the config of the main code
+config.set_main_option("sqlalchemy.url", settings.DATABASE_URL)
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+# target_metadata = None
+target_metadata = DBSpacecraft.metadata
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    connectable = engine_from_config(
+        config.get_section(config.config_ini_section, {}),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection, target_metadata=target_metadata
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

alembic/script.py.mako

@@ -0,0 +1,26 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

app/config.py

@@ -0,0 +1,9 @@
+from pydantic_settings import BaseSettings
+
+class Settings(BaseSettings):
+    DATABASE_URL: str
+
+    class Config:
+        env_file = ".env"
+
+settings = Settings()

app/db.py

@@ -1,6 +1,8 @@
 from sqlalchemy import create_engine
 from sqlalchemy.orm import declarative_base, sessionmaker
 
+from app.config import settings
+
 def get_db():
     db = SessionLocal()
     try:
@@ -9,7 +11,6 @@ def get_db():
         db.close()
 
 # SqlAlchemy Setup
-SQLALCHEMY_DATABASE_URL = 'sqlite:///./db.sqlite3'
-engine = create_engine(SQLALCHEMY_DATABASE_URL, echo=True, future=True)
+engine = create_engine(settings.DATABASE_URL)
 SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
 Base = declarative_base()

app/spacecraft/models.py

@@ -6,6 +6,8 @@ class DBSpacecraft(Base):
     __tablename__ = 'spacecraft'
 
     id = Column(Integer, primary_key=True, index=True)
-    name = Column(String, nullable=True)
+    name = Column(String, nullable=False)
     description = Column(String, nullable=True)
-    category = Column(String, nullable=True)
+    affiliation = Column(String, nullable=True)
+    dimensions = Column(String, nullable=True)
+    appearances = Column(Integer, nullable=False)

app/spacecraft/schemas.py

@@ -4,9 +4,11 @@
 # Pydantic Model
 class Spacecraft(BaseModel):
     id: int
-    name: Optional[str] = None
+    name: str
     description: Optional[str] = None
-    category: Optional[str] = None
+    affiliation: Optional[str] = None
+    dimensions: Optional[str] = None
+    appearances: int
 
     class Config:
         from_attributes = True

app/spacecraft/services.py

@@ -17,7 +17,9 @@ def update_item(db: Session, id: int, spacecraft: Spacecraft):
 
     db_spacecraft.name = spacecraft.name
     db_spacecraft.description = spacecraft.description
-    db_spacecraft.category = spacecraft.category
+    db_spacecraft.affiliation = spacecraft.affiliation
+    db_spacecraft.dimensions = spacecraft.dimensions
+    db_spacecraft.appearances = spacecraft.appearances
     db.add(db_spacecraft)
     db.commit()
     db.refresh(db_spacecraft)

requirements.txt

@@ -1,5 +1,8 @@
+alembic
 fastapi
 pydantic
+pydantic-settings
 pysqlite3
+python-dotenv
 sqlalchemy
 uvicorn[standard]