Meine Reise zum Erstellen einer Event-Management-CLI-App

Einführung

Als Anfänger in der Softwareentwicklung ist die Erstellung Ihres ersten bedeutenden Projekts eine der aufregendsten und entmutigendsten Aufgaben. Für mich war dies die Event Management CLI-Anwendung. Dieses Projekt hat mir nicht nur geholfen, mein Verständnis von Python zu festigen, sondern mich auch mit SQLAlchemy ORM, CLI-Bibliotheken wie Click und den allgemeinen Best Practices der Softwareentwicklung bekannt gemacht. Wenn ich über diese Reise nachdenke, wird mir klar, wie viel ich gelernt habe und wie diese Fähigkeiten mein Selbstvertrauen als Entwickler geprägt haben.

Die Anfänge: Erlernen der Grundlagen von Python

Bevor ich mich in dieses Projekt stürzte, begann meine Reise mit den Grundlagen von Python. Das Erlernen der Syntax, Kontrollstrukturen, Datentypen und Funktionen von Python war die Grundlage, die die Bewältigung dieses Projekts ermöglichte. Ich erinnere mich an die Tage, als ich einfache Skripte schrieb, Fehler debuggte und an die kleinen Siege, die mit jedem erfolgreichen Lauf einhergingen. Das Verständnis dieser Grundlagen war von entscheidender Bedeutung, da sie das Fundament jedes Python-Projekts bilden.

Einer der nützlichsten Aspekte, die ich schon früh gelernt habe, war die Verwaltung und Manipulation verschiedener Datenstrukturen, insbesondere Listen, Wörterbücher und Tupel. Diese Fähigkeiten waren unerlässlich, als ich mit der Arbeit an der Event Management CLI-App begann, wo ich mehrere Daten effizient speichern und verarbeiten musste.

Eintauchen in das Projekt: Einrichten der Umgebung

Der erste Schritt beim Erstellen der Event Management CLI-App war das Einrichten der Umgebung. Die Verwendung von Pipenv für die Verwaltung virtueller Umgebungen war eine neue Erfahrung. Es hat den Prozess der Abhängigkeitsverwaltung optimiert und sichergestellt, dass die Projektumgebung vom Rest meines Systems isoliert ist.

So richte ich die virtuelle Umgebung ein:

pipenv install
pipenv shell

Als nächstes habe ich Alembic für Datenbankmigrationen initialisiert. Dieser Schritt war entscheidend für die Verwaltung der Datenbankschemaänderungen im Laufe der Zeit.

alembic init migrations
alembic revision --autogenerate -m "Create Initial models"
alembic upgrade head

Erstellen der Modelle

Der Kern der Anwendung liegt in ihren Modellen. Mit SQLAlchemy ORM habe ich die Modelle für Benutzer, Ereignisse, Zeitpläne und Teilnehmer definiert. Hier kam mein Verständnis von Python-Klassen und SQLAlchemy zusammen. Hier ist ein Ausschnitt der models.py-Datei:

from sqlalchemy import Column, Integer, String, ForeignKey, DateTime, create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import relationship, sessionmaker

Base = declarative_base()

class User(Base):
    __tablename__ = 'users'
    id = Column(Integer, primary_key=True)
    username = Column(String, unique=True, nullable=False)

class Event(Base):
    __tablename__ = 'events'
    id = Column(Integer, primary_key=True)
    name = Column(String, nullable=False)
    description = Column(String)
    user_id = Column(Integer, ForeignKey('users.id'))

    user = relationship('User', back_populates='events')

class EventSchedule(Base):
    __tablename__ = 'event_schedules'
    id = Column(Integer, primary_key=True)
    event_id = Column(Integer, ForeignKey('events.id'))
    start_time = Column(DateTime, nullable=False)
    end_time = Column(DateTime, nullable=False)

    event = relationship('Event', back_populates='schedules')

class Attendee(Base):
    __tablename__ = 'attendees'
    id = Column(Integer, primary_key=True)
    name = Column(String, nullable=False)
    event_id = Column(Integer, ForeignKey('events.id'))

    event = relationship('Event', back_populates='attendees')

User.events = relationship('Event', order_by=Event.id, back_populates='user')
Event.schedules = relationship('EventSchedule', order_by=EventSchedule.id, back_populates='event')
Event.attendees = relationship('Attendee', order_by=Attendee.id, back_populates='event')

Ein nützlicher technischer Aspekt: ​​Beziehungen in SQLAlchemy

Einer der nützlichsten technischen Aspekte, die ich während dieses Projekts gelernt habe, war der Umgang mit Beziehungen in SQLAlchemy. Das Definieren von Beziehungen zwischen Tabellen mithilfe des ORM von SQLAlchemy erleichterte die Verwaltung der Daten und die Durchführung von Abfragen. Durch die Einrichtung einer Eins-zu-viele-Beziehung zwischen Benutzern und Ereignissen konnte ich beispielsweise problemlos alle von einem bestimmten Benutzer erstellten Ereignisse abfragen.

So habe ich die Beziehung zwischen Benutzer und Ereignis definiert:

class User(Base):
    __tablename__ = 'users'
    id = Column(Integer, primary_key=True)
    username = Column(String, unique=True, nullable=False)
    events = relationship('Event', order_by='Event.id', back_populates='user')

class Event(Base):
    __tablename__ = 'events'
    id = Column(Integer, primary_key=True)
    name = Column(String, nullable=False)
    description = Column(String)
    user_id = Column(Integer, ForeignKey('users.id'))
    user = relationship('User', back_populates='events')

Diese Beziehungsdefinition ermöglichte es mir, die Ereignisse eines Benutzers einfach abzufragen:

def get_user_events(user_id):
    user = session.query(User).filter(User.id == user_id).first()
    return user.events

Implementieren der CLI

Der CLI-Teil der Anwendung wurde mit Click implementiert. Diese Bibliothek machte es einfach, eine Befehlszeilenschnittstelle zu erstellen, die verschiedene Befehle und Optionen verarbeiten konnte. Hier ist ein Ausschnitt aus der cli.py-Datei:

import click
from models import User, Event, EventSchedule, Attendee
from db import session

@click.group()
def cli():
    pass

@click.command()
def create_event():
    name = click.prompt('Enter event name')
    description = click.prompt('Enter event description')
    user_id = click.prompt('Enter user ID', type=int)
    event = Event(name=name, description=description, user_id=user_id)
    session.add(event)
    session.commit()
    click.echo('Event created!')

cli.add_command(create_event)

if __name__ == '__main__':
    cli()

Rückblick

Rückblickend war dieses Projekt ein bedeutender Meilenstein auf meinem Weg als Entwickler. Es begann mit dem Erlernen der Grundlagen von Python, was den Grundstein für das Verständnis komplexerer Konzepte legte. Das Event Management CLI-App-Projekt war eine perfekte Mischung aus Python, SQL und Befehlszeilenschnittstellen und bot ein umfassendes Lernerlebnis.

Eine der größten Erkenntnisse aus diesem Projekt war die Bedeutung von Struktur und Organisation beim Codieren. Durch die Verwendung virtueller Umgebungen, die Verwaltung von Abhängigkeiten und die Aufrechterhaltung einer sauberen Projektstruktur wurde der Entwicklungsprozess reibungsloser und effizienter.

Darüber hinaus stärkte die praktische Erfahrung mit SQLAlchemy ORM und Click mein erworbenes theoretisches Wissen. Zu verstehen, wie man Beziehungen zwischen Tabellen definiert, Datenbankmigrationen durchführt und eine benutzerfreundliche CLI erstellt, waren von unschätzbarem Wert.

Abschluss

Die Erstellung der Event Management CLI-Anwendung war eine herausfordernde und dennoch lohnende Erfahrung. Es festigte mein Verständnis von Python und SQLAlchemy, führte mich in die Best Practices der Softwareentwicklung ein und verbesserte meine Fähigkeiten zur Problemlösung. Jedem Anfänger, der sich als Entwickler weiterentwickeln möchte, kann ich nur wärmstens empfehlen, sich in ein Projekt wie dieses zu stürzen. Es ist eine hervorragende Möglichkeit, das Gelernte anzuwenden, neue Werkzeuge und Techniken zu entdecken und etwas Greifbares zu schaffen, auf das Sie stolz sein können.

https://github.com/migsldev/event-management-app