diff --git a/lib/debug.py b/lib/debug.py index 4f922eb69..676f843ef 100644 --- a/lib/debug.py +++ b/lib/debug.py @@ -1,9 +1,15 @@ -#!/usr/bin/env python3 - from sqlalchemy import create_engine - -from models import Company, Dev +from sqlalchemy.orm import sessionmaker +from models import Company, Dev, Freebie if __name__ == '__main__': engine = create_engine('sqlite:///freebies.db') - import ipdb; ipdb.set_trace() + Session = sessionmaker(bind=engine) + session = Session() + + # Example: Print all developers and their freebies + devs = session.query(Dev).all() + for dev in devs: + print(f"{dev.name} received:") + for freebie in dev.freebies: + print(f" - {freebie.item_name} (${freebie.value}) from {freebie.company.name}") diff --git a/lib/freebies.db b/lib/freebies.db index 12beb1c96..c1f8ae7ab 100644 Binary files a/lib/freebies.db and b/lib/freebies.db differ diff --git a/lib/migrations/README b/lib/migrations/README index 98e4f9c44..2fcf60c2b 100644 --- a/lib/migrations/README +++ b/lib/migrations/README @@ -1 +1,100 @@ -Generic single-database configuration. \ No newline at end of file +# Freebie Tracker + +A simple Python project using SQLAlchemy and SQLite to track companies giving freebies to developers. +The project models companies, developers, and freebies, with functionality to manage freebie giveaways and relationships between entities. + +--- + +## Features + +- Models three entities: `Company`, `Dev` (Developer), and `Freebie`. +- Tracks freebies given by companies to developers. +- Supports giveaways (transferring freebies between developers). +- Query the oldest company by founding year. +- Relationships managed with SQLAlchemy ORM. +- Alembic migrations for database schema management. +- Seed script to populate the database with example data. + +--- + +## Requirements + +- Python 3.8+ +- SQLAlchemy `<2.0` (to avoid deprecation warnings) +- Alembic +- SQLite (used as the database engine) + +Install dependencies with: + +```bash +pip install sqlalchemy alembic +``` + +--- + +## Setup + +1. **Clone the repository:** + +```bash +git clone +cd python-p3-freebie-tracker/lib +``` + +2. **Create and apply migrations:** + +```bash +alembic upgrade head +``` + +3. **Run the seed script to populate the database with sample data:** + +```bash +python seed.py +``` + +--- + +## Usage + +After seeding the database, you can interact with the data using SQLAlchemy sessions and the methods defined in the models. + +### Example operations: + +- `Company.oldest_company(session)` + Get the company with the earliest founding year. + +- `company.give_freebie(dev, item_name, value)` + Company gives a new freebie to a developer. + +- `dev.received_one(item_name)` + Check if a developer received a particular freebie. + +- `dev.give_away(new_dev, freebie)` + Transfer a freebie from one developer to another. + +--- + +## Project Structure + +``` +lib/ +├── models.py # SQLAlchemy ORM models +├── seed.py # Script to clear and seed database with sample data +├── freebies.db # SQLite database file (generated after seeding) +└── migrations/ # Alembic migration scripts +``` + +--- + +## Notes + +- The project uses SQLite for simplicity and portability. +- SQLAlchemy 2.0 introduces breaking changes; this project uses SQLAlchemy `<2.0`. +- To silence deprecation warnings, pin the SQLAlchemy version in your requirements file. + +--- + +## Author + +Isaac Dev \ No newline at end of file diff --git a/lib/migrations/versions/18f1d7de9bb4_add_freebie_model.py b/lib/migrations/versions/18f1d7de9bb4_add_freebie_model.py new file mode 100644 index 000000000..e6e0a7535 --- /dev/null +++ b/lib/migrations/versions/18f1d7de9bb4_add_freebie_model.py @@ -0,0 +1,28 @@ +"""Add Freebie model + +Revision ID: 18f1d7de9bb4 +Revises: 9f1a9693bc3d +Create Date: 2025-05-25 21:37:15.503885 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '18f1d7de9bb4' +down_revision = '9f1a9693bc3d' +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/lib/migrations/versions/3f9de8b849d9_create_companies_devs_and_freebies_.py b/lib/migrations/versions/3f9de8b849d9_create_companies_devs_and_freebies_.py new file mode 100644 index 000000000..74b4c6145 --- /dev/null +++ b/lib/migrations/versions/3f9de8b849d9_create_companies_devs_and_freebies_.py @@ -0,0 +1,28 @@ +"""Create companies, devs, and freebies tables + +Revision ID: 3f9de8b849d9 +Revises: 18f1d7de9bb4 +Create Date: 2025-05-25 22:27:27.156435 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '3f9de8b849d9' +down_revision = '18f1d7de9bb4' +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/lib/migrations/versions/9f1a9693bc3d_create_companies_devs_and_freebies_.py b/lib/migrations/versions/9f1a9693bc3d_create_companies_devs_and_freebies_.py new file mode 100644 index 000000000..fb0ccdad7 --- /dev/null +++ b/lib/migrations/versions/9f1a9693bc3d_create_companies_devs_and_freebies_.py @@ -0,0 +1,37 @@ +"""Create companies, devs, and freebies tables + +Revision ID: 9f1a9693bc3d +Revises: 5f72c58bf48c +Create Date: 2025-05-25 21:21:57.370108 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '9f1a9693bc3d' +down_revision = '5f72c58bf48c' +branch_labels = None +depends_on = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + 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('dev_id', sa.Integer(), nullable=True), + sa.Column('company_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') + # ### end Alembic commands ### diff --git a/lib/models.py b/lib/models.py index 2681bee5a..0711d0451 100644 --- a/lib/models.py +++ b/lib/models.py @@ -1,7 +1,7 @@ -from sqlalchemy import ForeignKey, Column, Integer, String, MetaData -from sqlalchemy.orm import relationship, backref -from sqlalchemy.ext.declarative import declarative_base +from sqlalchemy import Column, Integer, String, ForeignKey, MetaData +from sqlalchemy.orm import declarative_base, relationship +# Naming convention for Alembic migrations convention = { "fk": "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s", } @@ -12,18 +12,72 @@ 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") + + @property + def devs(self): + # Return unique devs who got freebies from this company + return list({freebie.dev for freebie in self.freebies}) + + def give_freebie(self, dev, item_name, value): + """Create a new freebie for a dev from this company""" + new_freebie = Freebie(item_name=item_name, value=value, company=self, dev=dev) + return new_freebie + + @classmethod + def oldest_company(cls, session): + """Return the company with the smallest founding_year""" + return session.query(cls).order_by(cls.founding_year).first() 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") + + @property + def companies(self): + # Return unique companies who gave freebies to this dev + return list({freebie.company for freebie in self.freebies}) + + def received_one(self, item_name): + """Return True if dev has received a freebie with this item_name""" + return any(freebie.item_name == item_name for freebie in self.freebies) + + def give_away(self, new_dev, freebie): + """ + Transfer ownership of a freebie to another dev. + Returns True if successful, False if freebie does not belong to self. + """ + if freebie in self.freebies: + freebie.dev = new_dev + return True + return False + + 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..d48ca2579 100644 --- a/lib/seed.py +++ b/lib/seed.py @@ -1,3 +1,62 @@ -#!/usr/bin/env python3 +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker +from models import Company, Dev, Freebie -# Script goes here! +# Setup database connection and session +engine = create_engine('sqlite:///freebies.db') +Session = sessionmaker(bind=engine) +session = Session() + +# 1. Clear existing data (reset tables) +session.query(Freebie).delete() +session.query(Dev).delete() +session.query(Company).delete() +session.commit() # Commit after deletions + +print("Cleared old data.") # For your reference + +# 2. Create companies and devs +google = Company(name="Google", founding_year=1998) +microsoft = Company(name="Microsoft", founding_year=1975) +alice = Dev(name="Alice") +bob = Dev(name="Bob") + +session.add_all([google, microsoft, alice, bob]) +session.commit() # Commit after initial data insertion + +print("Added companies and developers.") + +# 3. Create freebies +f1 = Freebie(item_name="Sticker", value=1, company=google, dev=alice) +f2 = Freebie(item_name="T-shirt", value=10, company=microsoft, dev=alice) +f3 = Freebie(item_name="Mug", value=5, company=google, dev=bob) + +session.add_all([f1, f2, f3]) +session.commit() + +print("Added freebies.") + +# 4. Use Company method: give_freebie +keychain = google.give_freebie(alice, "Keychain", 3) +session.add(keychain) +session.commit() +print(f"Company gave a freebie: {keychain}") + +# 5. Use class method: oldest_company +oldest = Company.oldest_company(session) +print(f"Oldest company: {oldest}") + +# 6. Use Dev method: received_one +print(f"Alice received Sticker? {alice.received_one('Sticker')}") +print(f"Bob received T-shirt? {bob.received_one('T-shirt')}") + +# 7. Use Dev method: give_away +first_freebie = alice.freebies[0] +print(f"Before giveaway: {first_freebie.print_details()}") +success = alice.give_away(bob, first_freebie) +if success: + session.commit() + print(f"Freebie given away successfully.") +else: + print("Giveaway failed.") +print(f"After giveaway: {first_freebie.print_details()}")