diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 000000000..3c75dc542 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,118 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +# Use forward slashes (/) also on windows to provide an os agnostic path +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>=3.9 or backports.zoneinfo library and tzdata 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 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 = newline +# +# Use os.pathsep. Default configuration used for new projects. +version_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 +sqlalchemy.url = sqlite:///freebies.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 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 = 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 000000000..98e4f9c44 --- /dev/null +++ b/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/alembic/__pycache__/env.cpython-38.pyc b/alembic/__pycache__/env.cpython-38.pyc new file mode 100644 index 000000000..de784dbd2 Binary files /dev/null and b/alembic/__pycache__/env.cpython-38.pyc differ diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 000000000..36112a3c6 --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,78 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context + +# 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 = None + +# 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 000000000..fbc4b07dc --- /dev/null +++ b/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"} diff --git a/alembic/versions/090699fe5af3_create_freebies_table.py b/alembic/versions/090699fe5af3_create_freebies_table.py new file mode 100644 index 000000000..1ac97f6c6 --- /dev/null +++ b/alembic/versions/090699fe5af3_create_freebies_table.py @@ -0,0 +1,26 @@ +"""Create freebies table + +Revision ID: 090699fe5af3 +Revises: 2d41e641cabc +Create Date: 2025-05-28 08:04:31.234968 + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision: str = '090699fe5af3' +down_revision: Union[str, None] = '2d41e641cabc' +branch_labels: Union[str, Sequence[str], None] = None +depends_on: Union[str, Sequence[str], None] = None + + +def upgrade() -> None: + pass + + +def downgrade() -> None: + pass diff --git a/alembic/versions/2d41e641cabc_create_freebies_table.py b/alembic/versions/2d41e641cabc_create_freebies_table.py new file mode 100644 index 000000000..6d2e16c2e --- /dev/null +++ b/alembic/versions/2d41e641cabc_create_freebies_table.py @@ -0,0 +1,26 @@ +"""Create freebies table + +Revision ID: 2d41e641cabc +Revises: +Create Date: 2025-05-28 07:50:37.180474 + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision: str = '2d41e641cabc' +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: + pass + + +def downgrade() -> None: + pass diff --git a/alembic/versions/__pycache__/090699fe5af3_create_freebies_table.cpython-38.pyc b/alembic/versions/__pycache__/090699fe5af3_create_freebies_table.cpython-38.pyc new file mode 100644 index 000000000..5904d526a Binary files /dev/null and b/alembic/versions/__pycache__/090699fe5af3_create_freebies_table.cpython-38.pyc differ diff --git a/alembic/versions/__pycache__/2d41e641cabc_create_freebies_table.cpython-38.pyc b/alembic/versions/__pycache__/2d41e641cabc_create_freebies_table.cpython-38.pyc new file mode 100644 index 000000000..3046b66a9 Binary files /dev/null and b/alembic/versions/__pycache__/2d41e641cabc_create_freebies_table.cpython-38.pyc differ diff --git a/freebies.db b/freebies.db new file mode 100644 index 000000000..e8421e9be Binary files /dev/null and b/freebies.db differ diff --git a/lib/__pycache__/models.cpython-38.pyc b/lib/__pycache__/models.cpython-38.pyc new file mode 100644 index 000000000..18baa52fb Binary files /dev/null and b/lib/__pycache__/models.cpython-38.pyc differ diff --git a/lib/debug.py b/lib/debug.py index 4f922eb69..11cf99024 100644 --- a/lib/debug.py +++ b/lib/debug.py @@ -1,9 +1,15 @@ #!/usr/bin/env python3 from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker +from models import Company, Dev, Freebie -from models import Company, Dev +engine = create_engine('sqlite:///freebies.db') +Session = sessionmaker(bind=engine) +session = Session() if __name__ == '__main__': - engine = create_engine('sqlite:///freebies.db') + dev = session.query(Dev).first() + print(dev.companies) + import ipdb; ipdb.set_trace() diff --git a/lib/freebie.py b/lib/freebie.py new file mode 100644 index 000000000..d6c8e8600 --- /dev/null +++ b/lib/freebie.py @@ -0,0 +1,53 @@ +from sqlalchemy import ForeignKey, Column, Integer, String, MetaData +from sqlalchemy.orm import relationship, backref +from sqlalchemy.ext.declarative import declarative_base + + +convention = { + "fk": "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s", +} +metadata = MetaData(naming_convention=convention) +Base = declarative_base(metadata=metadata) + + +class Company(Base): + __tablename__ = 'companies' + + id = Column(Integer, primary_key=True) + name = Column(String) + founding_year = Column(Integer) + + freebies = relationship("Freebie", backref="company", cascade="all, delete-orphan") + + def __repr__(self): + return f"" + + +class Dev(Base): + __tablename__ = 'devs' + + id = Column(Integer, primary_key=True) + name = Column(String) + + + freebies = relationship("Freebie", backref="dev", cascade="all, delete-orphan") + + def __repr__(self): + return f"" + + +class Freebie(Base): + __tablename__ = 'freebies' + + id = Column(Integer, primary_key=True) + item_name = Column(String) + value = Column(Integer) + + dev_id = Column(Integer, ForeignKey('devs.id')) + company_id = Column(Integer, ForeignKey('companies.id')) + + def print_details(self): + return f"{self.dev.name} owns a {self.item_name} from {self.company.name}" + + def __repr__(self): + return f"" diff --git a/lib/freebies.db b/lib/freebies.db index 12beb1c96..e69de29bb 100644 Binary files a/lib/freebies.db and b/lib/freebies.db differ diff --git a/lib/migrations/versions/5f72c58bf48c_create_companies_devs.py b/lib/migrations/versions/5f72c58bf48c_create_companies_devs.py index c191bb2f9..b47257741 100644 --- a/lib/migrations/versions/5f72c58bf48c_create_companies_devs.py +++ b/lib/migrations/versions/5f72c58bf48c_create_companies_devs.py @@ -19,9 +19,9 @@ def upgrade() -> None: # ### commands auto generated by Alembic - please adjust! ### op.create_table('companies', - sa.Column('id', sa.Integer(), nullable=False), + sa.Column('id', sa.Integer(), primary_key=True, nullable=False), sa.Column('name', sa.String(), nullable=True), - sa.Column('founding_year', sa.Integer(), nullable=True), + sa.Column('founding_year', sa.Integer(), nullable=False), sa.PrimaryKeyConstraint('id') ) op.create_table('devs', diff --git a/lib/models.py b/lib/models.py index 2681bee5a..9246dd515 100644 --- a/lib/models.py +++ b/lib/models.py @@ -1,29 +1,51 @@ -from sqlalchemy import ForeignKey, Column, Integer, String, MetaData +from sqlalchemy import Column, Integer, String, ForeignKey from sqlalchemy.orm import relationship, backref from sqlalchemy.ext.declarative import declarative_base +from sqlalchemy import MetaData convention = { "fk": "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s", } metadata = MetaData(naming_convention=convention) - Base = declarative_base(metadata=metadata) class Company(Base): __tablename__ = 'companies' - id = Column(Integer(), primary_key=True) - name = Column(String()) - founding_year = Column(Integer()) + id = Column(Integer, primary_key=True) + name = Column(String) + founding_year = Column(Integer) + + freebies = relationship("Freebie", backref="company", cascade="all, delete-orphan") def __repr__(self): - return f'' + return f"" class Dev(Base): __tablename__ = 'devs' - id = Column(Integer(), primary_key=True) - name= Column(String()) + id = Column(Integer, primary_key=True) + name = Column(String) + + freebies = relationship("Freebie", backref="dev", cascade="all, delete-orphan") + + def companies(self): + return list({freebie.company for freebie in self.freebies}) + + def __repr__(self): + return f"" + +class Freebie(Base): + __tablename__ = 'freebies' + + id = Column(Integer, primary_key=True) + item_name = Column(String) + value = Column(Integer) + dev_id = Column(Integer, ForeignKey('devs.id')) + company_id = Column(Integer, ForeignKey('companies.id')) + + def print_details(self): + return f"{self.dev.name} owns a {self.item_name} from {self.company.name}" def __repr__(self): - return f'' + return f"" diff --git a/lib/seed.py b/lib/seed.py index b16becbbb..c1fb5b469 100644 --- a/lib/seed.py +++ b/lib/seed.py @@ -1,3 +1,27 @@ #!/usr/bin/env python3 -# Script goes here! +from models import Dev, Company, Freebie, Base +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker + +engine = create_engine("sqlite:///freebies.db") +Session = sessionmaker(bind=engine) +session = Session() + + +Base.metadata.drop_all(engine) +Base.metadata.create_all(engine) + + +dev1 = Dev(name="Hope") +dev2 = Dev(name="Sam") + +company1 = Company(name="Oyster", founding_year=2015) +company2 = Company(name="Cherubet", founding_year=1998) + +freebie1 = Freebie(item_name="Mug", value=10, dev=dev1, company=company1) +freebie2 = Freebie(item_name="T-shirt", value=15, dev=dev1, company=company2) +freebie3 = Freebie(item_name="Sticker", value=1, dev=dev2, company=company1) + +session.add_all([dev1, dev2, company1, company2, freebie1, freebie2, freebie3]) +session.commit()