diff --git a/Dockerfile b/Dockerfile index 1ca502b..ab9e788 100644 --- a/Dockerfile +++ b/Dockerfile @@ -5,8 +5,8 @@ WORKDIR /code COPY requirements.txt ./ RUN pip install --no-cache-dir -r requirements.txt -COPY alembic.ini ./ -COPY ./app /code/app +COPY ./src/alembic.ini ./ +COPY ./src/app /code/app COPY ./tests /code/tests CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8000"] diff --git a/docker-compose.yml b/docker-compose.yml index c2bf913..1e8dd84 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -17,7 +17,7 @@ services: ports: - "8000:8000" volumes: - - ./app/migrations/versions:/code/app/migrations/versions + - ./src/app/migrations/versions:/code/app/migrations/versions depends_on: - db diff --git a/src/alembic.ini b/src/alembic.ini new file mode 100644 index 0000000..e63faa7 --- /dev/null +++ b/src/alembic.ini @@ -0,0 +1,116 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = app/migrations + +# 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>=3.9 or backports.zoneinfo library. +# Any required deps can 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 migrations/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:migrations/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 = driver://user:pass@localhost/dbname + + +[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 exec runner, execute a binary +# hooks = ruff +# ruff.type = exec +# ruff.executable = %(here)s/.venv/bin/ruff +# ruff.options = --fix 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 diff --git a/src/app/__init__.py b/src/app/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/app/database.py b/src/app/database.py new file mode 100644 index 0000000..f6e7d41 --- /dev/null +++ b/src/app/database.py @@ -0,0 +1,14 @@ +from sqlmodel import create_engine, SQLModel, Session +from decouple import config + +# Get database configuration +DATABASE_URL = config('DATABASE_URL', cast=str, default='sqlite:///./bookapi.db') + +# Create database engine +engine = create_engine(str(DATABASE_URL), echo=True) +# SQLModel.metadata.create_all(engine) + +# Get database session +def get_session(): + with Session(engine) as session: + yield session diff --git a/src/app/main.py b/src/app/main.py new file mode 100644 index 0000000..55be0d7 --- /dev/null +++ b/src/app/main.py @@ -0,0 +1,45 @@ +from alembic import command +from alembic.config import Config +from fastapi import FastAPI +from sqlmodel import SQLModel + +from .database import engine +from .routers import api_router +from .routers.misc import get_info + +alembic_cfg = Config("alembic.ini") + +app = FastAPI( + title="LibraryAPI", + description="This is a sample API for managing authors and books.", + version="1.0.1", + openapi_tags=[ + { + "name": "authors", + "description": "Operations with authors.", + }, + { + "name": "books", + "description": "Operations with books.", + }, + { + "name": "relations", + "description": "Operations with relations.", + }, + { + "name": "misc", + "description": "Miscellaneous operations.", + } + ] +) + +# Initialize the database +@app.on_event("startup") +def on_startup(): + # Apply database migrations + with engine.begin() as connection: + alembic_cfg.attributes['connection'] = connection + command.upgrade(alembic_cfg, "head") + +# Include routers +app.include_router(api_router) diff --git a/src/app/migrations/README b/src/app/migrations/README new file mode 100644 index 0000000..98e4f9c --- /dev/null +++ b/src/app/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/src/app/migrations/env.py b/src/app/migrations/env.py new file mode 100644 index 0000000..14f3ac1 --- /dev/null +++ b/src/app/migrations/env.py @@ -0,0 +1,81 @@ +from logging.config import fileConfig +from decouple import config as conf +from alembic import context + +from sqlalchemy import engine_from_config +from sqlalchemy import pool +from sqlmodel import SQLModel + +DATABASE_URL = conf("DATABASE_URL") + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config +config.set_main_option("sqlalchemy.url", str(DATABASE_URL)) + +# 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 app.models import Book, Author, AuthorBookLink +target_metadata = SQLModel.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() \ No newline at end of file diff --git a/src/app/migrations/script.py.mako b/src/app/migrations/script.py.mako new file mode 100644 index 0000000..6ce3351 --- /dev/null +++ b/src/app/migrations/script.py.mako @@ -0,0 +1,27 @@ +"""${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 +import sqlmodel +${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"} diff --git a/src/app/migrations/versions/d266fdc61e99_init.py b/src/app/migrations/versions/d266fdc61e99_init.py new file mode 100644 index 0000000..42ca91d --- /dev/null +++ b/src/app/migrations/versions/d266fdc61e99_init.py @@ -0,0 +1,54 @@ +"""init + +Revision ID: d266fdc61e99 +Revises: +Create Date: 2025-05-27 18:04:22.279035 + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa +import sqlmodel + + +# revision identifiers, used by Alembic. +revision: str = 'd266fdc61e99' +down_revision: Union[str, None] = None +branch_labels: Union[str, Sequence[str], None] = None +depends_on: Union[str, Sequence[str], None] = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('author', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('name', sqlmodel.sql.sqltypes.AutoString(), nullable=False), + sa.PrimaryKeyConstraint('id') + ) + 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', sqlmodel.sql.sqltypes.AutoString(), nullable=False), + sa.Column('description', sqlmodel.sql.sqltypes.AutoString(), nullable=False), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_book_id'), 'book', ['id'], unique=False) + op.create_table('authorbooklink', + sa.Column('author_id', sa.Integer(), nullable=False), + sa.Column('book_id', sa.Integer(), nullable=False), + sa.ForeignKeyConstraint(['author_id'], ['author.id'], ), + sa.ForeignKeyConstraint(['book_id'], ['book.id'], ), + sa.PrimaryKeyConstraint('author_id', 'book_id') + ) + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('authorbooklink') + 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/src/app/models/__init__.py b/src/app/models/__init__.py new file mode 100644 index 0000000..9db9d41 --- /dev/null +++ b/src/app/models/__init__.py @@ -0,0 +1,5 @@ +from .author import Author, AuthorBase +from .book import Book, BookBase +from .links import AuthorBookLink + +__all__ = ['Author', 'AuthorBase', 'Book', 'BookBase', 'AuthorBookLink'] \ No newline at end of file diff --git a/src/app/models/author.py b/src/app/models/author.py new file mode 100644 index 0000000..a554e2d --- /dev/null +++ b/src/app/models/author.py @@ -0,0 +1,20 @@ +from typing import List, Optional +from sqlmodel import SQLModel, Field, Relationship +from .links import AuthorBookLink +from .book import Book + +# Author DTO model +class AuthorBase(SQLModel): + name: str + + class Config: # pyright: ignore + json_schema_extra = { + "example": { + "name": "author_name", + } + } + +# Author DB model +class Author(AuthorBase, table=True): + id: Optional[int] = Field(default=None, primary_key=True, index=True) + books: List["Book"] = Relationship(back_populates="authors", link_model=AuthorBookLink) diff --git a/src/app/models/book.py b/src/app/models/book.py new file mode 100644 index 0000000..8fabded --- /dev/null +++ b/src/app/models/book.py @@ -0,0 +1,22 @@ +from typing import List, Optional +from sqlmodel import SQLModel, Field, Relationship +from .links import AuthorBookLink +from .author import Author + +# Book DTO model +class BookBase(SQLModel): + title: str + description: str + + class Config: # pyright: ignore + json_schema_extra = { + "example": { + "title": "book_title", + "description": "book_description", + } + } + +# Book DB model +class Book(BookBase, table=True): + id: Optional[int] = Field(default=None, primary_key=True, index=True) + authors: List["Author"] = Relationship(back_populates="books", link_model=AuthorBookLink) diff --git a/src/app/models/links.py b/src/app/models/links.py new file mode 100644 index 0000000..343b557 --- /dev/null +++ b/src/app/models/links.py @@ -0,0 +1,6 @@ +from sqlmodel import SQLModel, Field + +# Relationship model +class AuthorBookLink(SQLModel, table=True): + author_id: int | None = Field(default=None, foreign_key="author.id", primary_key=True) + book_id: int | None = Field(default=None, foreign_key="book.id", primary_key=True) \ No newline at end of file diff --git a/src/app/routers/__init__.py b/src/app/routers/__init__.py new file mode 100644 index 0000000..f2847b1 --- /dev/null +++ b/src/app/routers/__init__.py @@ -0,0 +1,13 @@ +from fastapi import APIRouter + +from .authors import router as authors_router +from .books import router as books_router +from .relationships import router as relationships_router +from .misc import router as misc_router + +api_router = APIRouter() + +api_router.include_router(authors_router) +api_router.include_router(books_router) +api_router.include_router(relationships_router) +api_router.include_router(misc_router) \ No newline at end of file diff --git a/src/app/routers/authors.py b/src/app/routers/authors.py new file mode 100644 index 0000000..e4df02a --- /dev/null +++ b/src/app/routers/authors.py @@ -0,0 +1,45 @@ +from fastapi import APIRouter, Depends, HTTPException +from sqlmodel import Session, select +from typing import List + +from ..database import get_session +from ..models import Author, AuthorBase + +router = APIRouter(prefix="/authors", tags=["authors"]) + +# Create an author +@router.post("/", response_model=Author) +def create_author(author: AuthorBase, session: Session = Depends(get_session)): + db_author = Author(name=author.name) + session.add(db_author) + session.commit() + session.refresh(db_author) + return db_author + +# Read authors +@router.get("/", response_model=List[Author]) +def read_authors(session: Session = Depends(get_session)): + authors = session.exec(select(Author)).all() + return authors + +# Update an author +@router.put("/{author_id}", response_model=Author) +def update_author(author_id: int, author: AuthorBase, session: Session = Depends(get_session)): + db_author = session.get(Author, author_id) + if not db_author: + raise HTTPException(status_code=404, detail="Author not found") + db_author.name = author.name + session.commit() + session.refresh(db_author) + return db_author + +# Delete an author +@router.delete("/{author_id}", response_model=AuthorBase) +def delete_author(author_id: int, session: Session = Depends(get_session)): + db_author = session.get(Author, author_id) + if not db_author: + raise HTTPException(status_code=404, detail="Author not found") + session.delete(db_author) + author = AuthorBase(name=db_author.name) + session.commit() + return author \ No newline at end of file diff --git a/src/app/routers/books.py b/src/app/routers/books.py new file mode 100644 index 0000000..5c1d047 --- /dev/null +++ b/src/app/routers/books.py @@ -0,0 +1,62 @@ +from fastapi import APIRouter, Depends, HTTPException +from sqlmodel import Session, select +from typing import List + +from ..database import get_session +from ..models import Book, BookBase, Author, AuthorBookLink + +router = APIRouter(prefix="/books", tags=["books"]) + +# Create a book +@router.post("/", response_model=Book) +def create_book(book: BookBase, session: Session = Depends(get_session)): + db_book = Book(title=book.title, description=book.description) + session.add(db_book) + session.commit() + session.refresh(db_book) + return db_book + +# Read books +@router.get("/", response_model=List[Book]) +def read_books(session: Session = Depends(get_session)): + books = session.exec(select(Book)).all() + return books + +# Update a book +@router.put("/{book_id}", response_model=Book) +def update_book(book_id: int, book: BookBase, session: Session = Depends(get_session)): + db_book = session.get(Book, book_id) + if not db_book: + raise HTTPException(status_code=404, detail="Book not found") + + db_book.title = book.title + db_book.description = book.description + session.commit() + session.refresh(db_book) + return db_book + +# Delete a book +@router.delete("/{book_id}", response_model=BookBase) +def delete_book(book_id: int, session: Session = Depends(get_session)): + db_book = session.get(Book, book_id) + if not db_book: + raise HTTPException(status_code=404, detail="Book not found") + book = Book(title=db_book.title, description=db_book.description) + session.delete(db_book) + session.commit() + return book + +# Get all authors for a book +@router.get("/{book_id}/authors/", response_model=List[Author], tags=["relations"]) +def get_authors_for_book(book_id: int, session: Session = Depends(get_session)): + book = session.get(Book, book_id) + if not book: + raise HTTPException(status_code=404, detail="Book not found") + + authors = session.exec( + select(Author) + .join(AuthorBookLink) + .where(AuthorBookLink.book_id == book_id) + ).all() + + return authors \ No newline at end of file diff --git a/src/app/routers/misc.py b/src/app/routers/misc.py new file mode 100644 index 0000000..c0665f3 --- /dev/null +++ b/src/app/routers/misc.py @@ -0,0 +1,32 @@ +from fastapi import APIRouter, Request +from fastapi.responses import HTMLResponse, JSONResponse +from fastapi.templating import Jinja2Templates +from pathlib import Path +from datetime import datetime +from typing import Dict + +# Инициализация шаблонов +templates = Jinja2Templates(directory=Path(__file__).parent.parent / "templates") + +router = APIRouter(tags=["misc"]) + +def get_info(app) -> Dict: + return { + "status": "ok", + "app_info": { + "title": app.title, + "version": app.version, + "description": app.description, + }, + "server_time": datetime.now().isoformat(), + } + +# Root endpoint +@router.get("/", response_class=HTMLResponse) +async def root(request: Request, app=None): + return templates.TemplateResponse("index.html", {"request": request, "data": get_info(app)}) + +# API Information endpoint +@router.get("/api/info") +async def api_info(app=None): + return JSONResponse(content=get_info(app)) \ No newline at end of file diff --git a/src/app/routers/relationships.py b/src/app/routers/relationships.py new file mode 100644 index 0000000..42c3091 --- /dev/null +++ b/src/app/routers/relationships.py @@ -0,0 +1,54 @@ +from fastapi import APIRouter, Depends, HTTPException +from sqlmodel import Session, select +from typing import List, Dict + +from ..database import get_session +from ..models import Author, Book, AuthorBookLink + +router = APIRouter(prefix="/relationships", tags=["relations"]) + +# Add author to book +@router.post("/", response_model=AuthorBookLink) +def add_author_to_book(author_id: int, book_id: int, session: Session = Depends(get_session)): + # Check if author and book exist + author = session.get(Author, author_id) + if not author: + raise HTTPException(status_code=404, detail="Author not found") + + book = session.get(Book, book_id) + if not book: + raise HTTPException(status_code=404, detail="Book not found") + + # Check if relationship already exists + existing_link = session.exec( + select(AuthorBookLink) + .where(AuthorBookLink.author_id == author_id) + .where(AuthorBookLink.book_id == book_id) + ).first() + + if existing_link: + raise HTTPException(status_code=400, detail="Relationship already exists") + + # Create new relationship + link = AuthorBookLink(author_id=author_id, book_id=book_id) + session.add(link) + session.commit() + session.refresh(link) + return link + +# Remove author from book +@router.delete("/", response_model=Dict[str, str]) +def remove_author_from_book(author_id: int, book_id: int, session: Session = Depends(get_session)): + # Find the relationship + link = session.exec( + select(AuthorBookLink) + .where(AuthorBookLink.author_id == author_id) + .where(AuthorBookLink.book_id == book_id) + ).first() + + if not link: + raise HTTPException(status_code=404, detail="Relationship not found") + + session.delete(link) + session.commit() + return {"message": "Relationship removed successfully"} \ No newline at end of file diff --git a/src/app/templates/index.html b/src/app/templates/index.html new file mode 100644 index 0000000..c9b6997 --- /dev/null +++ b/src/app/templates/index.html @@ -0,0 +1,56 @@ + + + + + + {{ data.title }} + + + +

Welcome to {{ data.title }}!

+

Description: {{ data.description }}

+

Version: {{ data.version }}

+

Current Time: {{ data.time }}

+

Status: {{ data.status }}

+ + +