diff --git a/__pycache__/models.cpython-38.pyc b/__pycache__/models.cpython-38.pyc new file mode 100644 index 000000000..dee440274 Binary files /dev/null and b/__pycache__/models.cpython-38.pyc differ diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 000000000..b3253c532 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,105 @@ +# 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. + +# 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 + +# 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/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/env.py b/alembic/env.py new file mode 100644 index 000000000..f8631c6ba --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,85 @@ +import sys +import os + +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context +sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))) + +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 000000000..55df2863d --- /dev/null +++ b/alembic/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + + +def upgrade() -> None: + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + ${downgrades if downgrades else "pass"} diff --git a/alembic/versions/24f87fd25848_create_freebies_table.py b/alembic/versions/24f87fd25848_create_freebies_table.py new file mode 100644 index 000000000..e5b4eaf7a --- /dev/null +++ b/alembic/versions/24f87fd25848_create_freebies_table.py @@ -0,0 +1,50 @@ +"""Create freebies table + +Revision ID: 24f87fd25848 +Revises: +Create Date: 2025-03-03 11:48:05.680002 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '24f87fd25848' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('companies', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('name', sa.String(), nullable=True), + sa.Column('founding_year', sa.Integer(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('devs', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('name', sa.String(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('freebies', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('item_name', sa.String(), nullable=True), + sa.Column('value', sa.Integer(), nullable=True), + sa.Column('company_id', sa.Integer(), nullable=True), + sa.Column('dev_id', sa.Integer(), nullable=True), + sa.ForeignKeyConstraint(['company_id'], ['companies.id'], name=op.f('fk_freebies_company_id_companies')), + sa.ForeignKeyConstraint(['dev_id'], ['devs.id'], name=op.f('fk_freebies_dev_id_devs')), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('freebies') + op.drop_table('devs') + op.drop_table('companies') + # ### end Alembic commands ### diff --git a/alembic/versions/3d40514581a3_fixing_model_imports.py b/alembic/versions/3d40514581a3_fixing_model_imports.py new file mode 100644 index 000000000..e80465678 --- /dev/null +++ b/alembic/versions/3d40514581a3_fixing_model_imports.py @@ -0,0 +1,28 @@ +"""Fixing model imports + +Revision ID: 3d40514581a3 +Revises: a192f90d7ef8 +Create Date: 2025-03-03 16:46:35.042066 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '3d40514581a3' +down_revision = 'a192f90d7ef8' +branch_labels = None +depends_on = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + pass + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + pass + # ### end Alembic commands ### diff --git a/alembic/versions/8e45d8c8ea51_add_relationships_to_freebie.py b/alembic/versions/8e45d8c8ea51_add_relationships_to_freebie.py new file mode 100644 index 000000000..595a8948b --- /dev/null +++ b/alembic/versions/8e45d8c8ea51_add_relationships_to_freebie.py @@ -0,0 +1,28 @@ +"""Add relationships to Freebie + +Revision ID: 8e45d8c8ea51 +Revises: 24f87fd25848 +Create Date: 2025-03-03 11:59:28.790280 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '8e45d8c8ea51' +down_revision = '24f87fd25848' +branch_labels = None +depends_on = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + pass + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + pass + # ### end Alembic commands ### diff --git a/alembic/versions/a192f90d7ef8_add_query_methods.py b/alembic/versions/a192f90d7ef8_add_query_methods.py new file mode 100644 index 000000000..ed21791db --- /dev/null +++ b/alembic/versions/a192f90d7ef8_add_query_methods.py @@ -0,0 +1,28 @@ +"""Add query methods + +Revision ID: a192f90d7ef8 +Revises: 8e45d8c8ea51 +Create Date: 2025-03-03 12:22:17.597765 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'a192f90d7ef8' +down_revision = '8e45d8c8ea51' +branch_labels = None +depends_on = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + pass + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + pass + # ### end Alembic commands ### diff --git a/debug.py b/debug.py new file mode 100644 index 000000000..c0bc9fae8 --- /dev/null +++ b/debug.py @@ -0,0 +1,35 @@ +import ipdb +from models import Base, Company, Dev, Freebie +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker + +# Setup database connection +engine = create_engine('sqlite:///freebies.db') +Session = sessionmaker(bind=engine) +session = Session() + +#Some data for testing +ava = session.query(Dev).filter_by(name="Ava Sinclair").first() +quantum_soft = session.query(Company).filter_by(name="QuantumSoft").first() +nebula_tshirt = session.query(Freebie).filter_by(item_name="Nebula T-Shirt").first() + +#Debugging breakpoint +ipdb.set_trace() + +#session.close() + +##Commands to run +#session.query(Company).all() #Gets all companies +#session.query(Dev).all() #Gets all the devs +#session.query(Freebie).all() #Gets all the Freebies + +#p ava.received_one("Nebula T-shirt") #Checks if a dev recieved a freebie +#p ava.freebies #Checks all freebies a dev received +#for freebie in ava.freebies: print (freebie.print_details()) ##Checks the details of a freebie +#p session.query(Company).order_by(Company.name).all() #Checks all companies in alphabetical order +#p Company.oldest_company(session) #Checks the oldest company +#p len(ava.freebies) #checks how many freebies a dev has +#p session.query(Dev).join(Freebie).filter(Freebie.item_name == "Nebula T-Shirt").all() #checks which dev owns a specific freebie + + + diff --git a/freebies.db b/freebies.db new file mode 100644 index 000000000..4f42b8c3a 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..d09563fd6 Binary files /dev/null and b/lib/__pycache__/models.cpython-38.pyc differ diff --git a/lib/models.py b/lib/models.py deleted file mode 100644 index 2681bee5a..000000000 --- a/lib/models.py +++ /dev/null @@ -1,29 +0,0 @@ -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()) - - def __repr__(self): - return f'' - -class Dev(Base): - __tablename__ = 'devs' - - id = Column(Integer(), primary_key=True) - name= Column(String()) - - def __repr__(self): - return f'' diff --git a/models.py b/models.py new file mode 100644 index 000000000..84a3b003e --- /dev/null +++ b/models.py @@ -0,0 +1,79 @@ +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()) + + #Define a one-to-many relationship with Freebie model + freebies = relationship('Freebie', back_populates='company') + + def __repr__(self): + return f'' + + def give_freebie(self, dev, item_name, value, session): + """Creates a new Freebie for a given Dev and commits it to the database""" + freebie = Freebie(item_name=item_name, value=value, company=self, dev=dev) + session.add(freebie) + session.commit() + + @classmethod + def oldest_company(cls, session): + """Returns the company with the earliest founding year.""" + return session.query(cls).order_by(cls.founding_year).first() + +class Dev(Base): + __tablename__ = 'devs' + + id = Column(Integer(), primary_key=True) + name= Column(String()) + + freebies = relationship('Freebie', back_populates='dev') + + def __repr__(self): + return f'' + + def received_one(self, item_name): + """Checks if the Dev has received a freebie with the specified item name.""" + return any(freebie.item_name == item_name for freebie in self.freebies) + + def give_away(self, freebie, other_dev, session): + """ + Transfers a Freebie to another Dev only if it belongs to the current Dev. + Updates the database session if the transfer is successful. + """ + if freebie in self.freebies: + freebie.dev = other_dev + session.commit() + else: + raise ValueError(f"{self.name} doesn't own this freebie!") + +class Freebie(Base): + __tablename__ = 'freebies' + + id = Column(Integer, primary_key=True) + item_name = Column(String) + value = Column(Integer) + company_id = Column(Integer, ForeignKey('companies.id')) + dev_id = Column(Integer, ForeignKey('devs.id')) + + company = relationship('Company', back_populates='freebies') + dev = relationship('Dev', back_populates='freebies') + + def __repr__(self): + return f'' + + def print_details(self): + """Prints details of the freebie in the format: '{dev_name} owns a {item_name} from {company_name}'.""" + return f"{self.dev.name} owns a {self.item_name} from {self.company.name}" diff --git a/seed.py b/seed.py new file mode 100644 index 000000000..22bb5087b --- /dev/null +++ b/seed.py @@ -0,0 +1,45 @@ +from models import Company, Dev, Freebie +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker + +# Set up the database connection +engine = create_engine('sqlite:///freebies.db') +Session = sessionmaker(bind=engine) +session = Session() + +# Clear existing data to avoid duplicates +session.query(Company).delete() +session.query(Dev).delete() +session.query(Freebie).delete() + +# Create some unique companies +company1 = Company(name="NebulaTech", founding_year=2012) +company2 = Company(name="QuantumSoft", founding_year=2008) +company3 = Company(name="ByteForge", founding_year=2015) +company4 = Company(name="CipherWave", founding_year=2010) + +# Create some unique developers +dev1 = Dev(name="Ava Sinclair") +dev2 = Dev(name="Ethan Cole") +dev3 = Dev(name="Maya Bennett") +dev4 = Dev(name="Jordan Hayes") +dev5 = Dev(name="Noah Carter") + +# Assign freebies to developers from different companies +freebie1 = Freebie(item_name="Nebula T-Shirt", value=25, company=company1, dev=dev1) +freebie2 = Freebie(item_name="Quantum Mousepad", value=15, company=company2, dev=dev2) +freebie3 = Freebie(item_name="ByteForge Mug", value=10, company=company3, dev=dev3) +freebie4 = Freebie(item_name="CipherWave Hoodie", value=50, company=company4, dev=dev4) +freebie5 = Freebie(item_name="Nebula Notebook", value=20, company=company1, dev=dev5) +freebie6 = Freebie(item_name="Quantum USB Drive", value=30, company=company2, dev=dev1) +freebie7 = Freebie(item_name="ByteForge Sticker Pack", value=5, company=company3, dev=dev2) +freebie8 = Freebie(item_name="CipherWave Water Bottle", value=18, company=company4, dev=dev3) + +# Add everything to the session and commit +session.add_all([company1, company2, company3, company4, dev1, dev2, dev3, dev4, dev5, + freebie1, freebie2, freebie3, freebie4, freebie5, freebie6, freebie7, freebie8]) +session.commit() + +print("✅ Database successfully seeded!") +session.close() +