mrmuli / bc-9-eventbuzz Goto Github PK

Event Buzz is a console application that facilitates a ticket booking service
Event Buzz allows a user to do the following:

• Create a new event with a name, start date, end date and venue
• Generate tickets for events and send an email update
• Invalidate a ticket
• View an event's tickets
• Delete an event
• List out all events
• Send email updates on an event's schedule

1. Docopt - This is a Pythonic package that allows creating the command-line interface for eventbuzz.
2. SQlite - This is a light-weight relational database that eventbuzz uses to store event data.
3. SQL Alchemy - This is a python SQL toolkit and Object relational mapper.
4. smtplib - This is a python library that handles sending of emails via python modules.
5. python-crontab - This is a python library that enables scheduling of various tasks.
6. mailgun - Mailgun offers an API for sending emails.

• Navigate to a directory of choice on terminal.

• Clone this repository from Github on that directory.

  • Using SSH;

    [email protected]:josephmuli/bc-9-eventbuzz.git

  • Using HTTP;

    https://github.com/josephmuli/bc-9-eventbuzz.git

• Navigate to the repo's folder on your computer

  • cd bc-9-eventbuzz

• Install the app's dependencies. I advice using a virtual environment

  • pip install -r requirements.txt

• Run the app

  • python tickets.py -i for interactive mode

• Tests have been written using the python unittest framework.
• To run the tests, navigate to the project's root folder,
• issue the following command on terminal.
  • python buzz_tests.py
• If the tests are successful, they will not display any error or failure.

• Cron jobs to be assigned email addresses
• User profiles for user identification
• Event edit for event detail change