diff --git a/.flake8 b/.flake8 new file mode 100644 index 00000000..4e2c1dad --- /dev/null +++ b/.flake8 @@ -0,0 +1,6 @@ +[flake8] +inline-quotes = " +max-line-length = 79 +max-complexity = 18 +select = B,C,E,F,W,T4,B9,ANN,Q0,N8,VNE +exclude = .venv, alembic diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 00000000..fa53456e --- /dev/null +++ b/alembic.ini @@ -0,0 +1,149 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts. +# this is typically a path given in POSIX (e.g. forward slashes) +# format, relative to the token %(here)s which refers to the location of this +# ini file +script_location = %(here)s/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 +# Or organize into date-based subdirectories (requires recursive_version_locations = true) +# file_template = %%(year)d/%%(month).2d/%%(day).2d_%%(hour).2d%%(minute).2d_%%(second).2d_%%(rev)s_%%(slug)s + +# sys.path path, will be prepended to sys.path if present. +# defaults to the current working directory. for multiple paths, the path separator +# is defined by "path_separator" below. +prepend_sys_path = . + + +# timezone to use when rendering the date within the migration file +# as well as the filename. +# If specified, requires the tzdata library which can be installed by adding +# `alembic[tz]` to the pip requirements. +# string value is passed to ZoneInfo() +# 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 /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 "path_separator" +# below. +# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions + +# path_separator; This indicates what character is used to split lists of file +# paths, including version_locations and prepend_sys_path within configparser +# files such as alembic.ini. +# The default rendered in new alembic.ini files is "os", which uses os.pathsep +# to provide os-dependent path splitting. +# +# Note that in order to support legacy alembic.ini files, this default does NOT +# take place if path_separator is not present in alembic.ini. If this +# option is omitted entirely, fallback logic is as follows: +# +# 1. Parsing of the version_locations option falls back to using the legacy +# "version_path_separator" key, which if absent then falls back to the legacy +# behavior of splitting on spaces and/or commas. +# 2. Parsing of the prepend_sys_path option falls back to the legacy +# behavior of splitting on spaces, commas, or colons. +# +# Valid values for path_separator are: +# +# path_separator = : +# path_separator = ; +# path_separator = space +# path_separator = newline +# +# Use os.pathsep. Default configuration used for new projects. +path_separator = os + +# 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 + +# database URL. This is consumed by the user-maintained env.py script only. +# other means of configuring database URLs may be customized within the env.py +# file. +sqlalchemy.url = sqlite:///./sql_library.db + + +[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 + +# lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module +# hooks = ruff +# ruff.type = module +# ruff.module = ruff +# ruff.options = check --fix REVISION_SCRIPT_FILENAME + +# Alternatively, use the exec runner to execute a binary found on your PATH +# hooks = ruff +# ruff.type = exec +# ruff.executable = ruff +# ruff.options = check --fix REVISION_SCRIPT_FILENAME + +# Logging configuration. This is also consumed by the user-maintained +# env.py script only. +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARNING +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARNING +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 diff --git a/alembic/README b/alembic/README new file mode 100644 index 00000000..98e4f9c4 --- /dev/null +++ b/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 00000000..55c0ce3d --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,80 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context + +from models import Base + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +if config.config_file_name is not None: + 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 = Base.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() diff --git a/alembic/script.py.mako b/alembic/script.py.mako new file mode 100644 index 00000000..11016301 --- /dev/null +++ b/alembic/script.py.mako @@ -0,0 +1,28 @@ +"""${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, Sequence[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: + """Upgrade schema.""" + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + """Downgrade schema.""" + ${downgrades if downgrades else "pass"} diff --git a/alembic/versions/65f3fa91bd82_init.py b/alembic/versions/65f3fa91bd82_init.py new file mode 100644 index 00000000..57210e42 --- /dev/null +++ b/alembic/versions/65f3fa91bd82_init.py @@ -0,0 +1,53 @@ +"""Init + +Revision ID: 65f3fa91bd82 +Revises: +Create Date: 2026-05-08 21:11:17.034314 + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision: str = '65f3fa91bd82' +down_revision: Union[str, Sequence[str], None] = None +branch_labels: Union[str, Sequence[str], None] = None +depends_on: Union[str, Sequence[str], None] = None + + +def upgrade() -> None: + """Upgrade schema.""" + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('author', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('name', sa.String(length=255), nullable=False), + sa.Column('bio', sa.String(length=255), nullable=False), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('name') + ) + op.create_index(op.f('ix_author_id'), 'author', ['id'], unique=False) + op.create_table('book', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('title', sa.String(), nullable=False), + sa.Column('summary', sa.String(length=255), nullable=False), + sa.Column('publication_date', sa.Date(), nullable=False), + sa.Column('author_id', sa.Integer(), nullable=False), + sa.ForeignKeyConstraint(['author_id'], ['author.id'], ), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('title') + ) + op.create_index(op.f('ix_book_id'), 'book', ['id'], unique=False) + # ### end Alembic commands ### + + +def downgrade() -> None: + """Downgrade schema.""" + # ### commands auto generated by Alembic - please adjust! ### + op.drop_index(op.f('ix_book_id'), table_name='book') + op.drop_table('book') + op.drop_index(op.f('ix_author_id'), table_name='author') + op.drop_table('author') + # ### end Alembic commands ### diff --git a/crud.py b/crud.py new file mode 100644 index 00000000..600c62a1 --- /dev/null +++ b/crud.py @@ -0,0 +1,80 @@ +from sqlalchemy import select +from sqlalchemy.orm import Session + +import models +import schemas + + +def create_author( + db: Session, + author: schemas.AuthorCreate +) -> models.DBAuthor: + db_author = models.DBAuthor( + name=author.name, + bio=author.bio + ) + db.add(db_author) + db.commit() + db.refresh(db_author) + + return db_author + + +def retrieve_author_by_id( + db: Session, + author_id: int +) -> models.DBAuthor: + + return db.get(models.DBAuthor, author_id) + + +def get_author_by_name( + db: Session, + name: str +) -> models.DBAuthor: + stmt = select(models.DBAuthor).where(models.DBAuthor.name == name) + + return db.scalars(stmt).first() + + +def retrieve_authors( + db: Session, + skip: int = 0, + limit: int = 100 +) -> list[models.DBAuthor]: + stmt = select(models.DBAuthor).offset(skip).limit(limit) + + return list(db.scalars(stmt).all()) + + +def create_book( + db: Session, + book: schemas.BookCreate +) -> models.DBBook: + + db_book = models.DBBook( + title=book.title, + summary=book.summary, + author_id=book.author_id, + publication_date=book.publication_date + ) + db.add(db_book) + db.commit() + db.refresh(db_book) + + return db_book + + +def retrieve_books( + db: Session, + skip: int = 0, + limit: int = 100, + author_id: int | None = None +) -> list[models.DBBook]: + stmt = select(models.DBBook).offset(skip).limit(limit) + if author_id: + stmt = stmt.where( + models.DBBook.author_id == author_id + ) + + return list(db.scalars(stmt).all()) diff --git a/database.py b/database.py new file mode 100644 index 00000000..a29a548a --- /dev/null +++ b/database.py @@ -0,0 +1,15 @@ +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker +from sqlalchemy.ext.declarative import declarative_base + +SQL_ALCHEMY_DATABASE_URL = "sqlite:///./sql_library.db" + +engine = create_engine( + SQL_ALCHEMY_DATABASE_URL, + connect_args={"check_same_thread": False} +) + +SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) + + +Base = declarative_base() diff --git a/main.py b/main.py new file mode 100644 index 00000000..1cf44997 --- /dev/null +++ b/main.py @@ -0,0 +1,122 @@ +from typing import Generator, List, Annotated + +from sqlalchemy.orm import Session +from fastapi import FastAPI, Depends, HTTPException + +import crud +import models +import schemas +from database import engine, SessionLocal + + +class AuthorNotExist(HTTPException): + def __init__( + self, + author_id: int + ): + super().__init__( + status_code=400, + detail=f"Author with id '{author_id}' does not exist" + ) + + +class AuthorAlreadyExists(HTTPException): + def __init__( + self, + author_index: str + ): + super().__init__( + status_code=400, + detail=f"Author with index '{author_index}' already exists" + ) + + +models.Base.metadata.create_all(bind=engine) + + +app = FastAPI() + + +def get_db() -> Generator[Session, None, None]: + db = SessionLocal() + + try: + yield db + finally: + db.close() + + +@app.get("/") +def root(): + return {"message": "Hello World"} + + +@app.post("/book/", response_model=schemas.Book) +def create_book( + book: schemas.BookCreate, + db: Annotated[Session, Depends(get_db)], +) -> models.DBBook: + + if not crud.retrieve_author_by_id(db=db, author_id=book.author_id): + raise AuthorNotExist(author_id=book.author_id) + + return crud.create_book(db=db, book=book) + + +@app.post("/author/", response_model=schemas.Author) +def create_author( + author: schemas.AuthorCreate, + db: Annotated[Session, Depends(get_db)] +) -> models.DBAuthor: + + if crud.get_author_by_name(db=db, name=author.name): + raise AuthorAlreadyExists(author_index=author.name) + + return crud.create_author(db=db, author=author) + + +@app.get("/authors", response_model=list[schemas.Author]) +def get_authors( + db: Annotated[Session, Depends(get_db)], + skip: int = 0, + limit: int = 100 +) -> List[models.DBAuthor]: + + return crud.retrieve_authors(db=db, skip=skip, limit=limit) + + +@app.get("/author/{author_id}", response_model=schemas.Author) +def get_author( + db: Annotated[Session, Depends(get_db)], + author_id: int +) -> models.DBAuthor: + + author = crud.retrieve_author_by_id(db=db, author_id=author_id) + + if not author: + raise AuthorNotExist(author_id=author_id) + + return author + + +@app.get("/books", response_model=list[schemas.Book]) +def get_books( + db: Annotated[Session, Depends(get_db)], + skip: int = 0, + limit: int = 100, + author_id: int | None = None +) -> list[models.DBBook]: + + if ( + author_id and not crud.retrieve_author_by_id( + db=db, + author_id=author_id) + ): + raise AuthorNotExist(author_id=author_id) + + return crud.retrieve_books( + db=db, + skip=skip, + limit=limit, + author_id=author_id + ) diff --git a/models.py b/models.py new file mode 100644 index 00000000..d964a297 --- /dev/null +++ b/models.py @@ -0,0 +1,27 @@ +from typing import List + +from sqlalchemy import String, ForeignKey, Date +from sqlalchemy.orm import Mapped, mapped_column, relationship + +from database import Base + + +class DBAuthor(Base): + __tablename__ = "author" + + id: Mapped[int] = mapped_column(primary_key=True, index=True) + name: Mapped[str] = mapped_column(String(255), unique=True) + bio: Mapped[str] = mapped_column(String(255)) + books: Mapped[List["DBBook"]] = relationship("DBBook") + + +class DBBook(Base): + __tablename__ = "book" + + id: Mapped[int] = mapped_column(primary_key=True, index=True) + title: Mapped[str] = mapped_column(unique=True) + summary: Mapped[str] = mapped_column(String(255)) + publication_date: Mapped[Date] = mapped_column(Date) + + author_id: Mapped[int] = mapped_column(ForeignKey("author.id")) + author: Mapped["DBAuthor"] = relationship("DBAuthor") diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..d78fa26c --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +fastapi +sqlalchemy +alembic +uvicorn \ No newline at end of file diff --git a/schemas.py b/schemas.py new file mode 100644 index 00000000..ac7c30ce --- /dev/null +++ b/schemas.py @@ -0,0 +1,32 @@ +from pydantic import BaseModel, ConfigDict +from datetime import date + + +class AuthorBase(BaseModel): + name: str + bio: str + + +class AuthorCreate(AuthorBase): + pass + + +class Author(AuthorBase): + model_config = ConfigDict(from_attributes=True) + id: int + + +class BookBase(BaseModel): + title: str + summary: str + publication_date: date + author_id: int + + +class BookCreate(BookBase): + pass + + +class Book(BookBase): + model_config = ConfigDict(from_attributes=True) + id: int