Shelfie

A Library Management System developed using tkinter in Python

Description

Note

ALL CONTENTS IN THIS REPO ARE FOR EDUCATIONAL PURPOSES ONLY.

Shelfie! is a GUI for a simple personal home library management system, developed using the tkinter library in Python. You can browse, add, update and delete book records saved on a SQLite database.

More screenshots below.

Table of Contents

• Description
• Features
• Project Structure
• Prerequisites
• Getting Started
  • Dependencies
  • Installation
  • Configuration
  • Usage
• Author(s)
• Version History
  • Release Notes
  • Initial Release
• Future Work
• License
• Contributing
• Acknowledgments
• Screenshots

Features

• Simple and intuitive user interface built with Tkinter
• Basic CRUD operations on book records
• Cross-platform compatibility (Windows, macOS, Linux)

Project Structure

shelfie/
│
├── app/
│   │
│   ├── assets/
│   │   ├── copy/
│   │   └── images/
│   │
│   ├── config/
│   │   └── __init__.py
│   │
│   ├── data/
│   │
│   └── shelfie.py
│
├── docs/
├── .gitignore
├── LICENSE
├── README.md
└── requirements.txt

Prerequisites

Before you begin, ensure you have met the following requirements:

• Python (version 3.9 or higher)
• git (for cloning the repository)

Getting Started

Dependencies

• See requirements.txt

Installation

1. Clone the repository

   git clone https://github.com/ggeerraarrdd/shelfie.git

2. Navigate into the project directory

   cd shelfie # For example

3. Create and activate a virtual environment

   python -m venv venv
   source venv/bin/activate  # On Windows use `venv\Scripts\activate`

4. Install the dependencies

   pip install -r requirements.txt

Configuration

• None

Usage

1. Go into the app directory and run the command

   python3 shelfie.py

2. Log in

   Click Sign in.

   Note: The provided username and password are dummy credentials. The app lacks user authentication and management functionality. There is no data model or CRUD operations implemented for user accounts.

Author(s)

• @ggeerraarrdd

Version History

Release Notes

• See https://github.com/ggeerraarrdd/shelfie/releases

Initial Release

The initial release of Shelfie! was submitted as the final project for IS411: Introduction to Programming for Business Applications (DePaul University, Autumn 2022). That version used a PostgreSQL database instance hosted on AWS and the psycopg2 library.

Project brief as of Autumn 2022:

[Not posted.]

Future Work

No ongoing development.

• Clean up code (Update May 28, 2023: Code too unwieldy, so leaving Tkinter version behind and moving on to the web version from scratch.)
• Create a web version using a web framework (Flask or Django) (Update Oct 14, 2023: Github does not need another book management system repo)

License

• MIT License

Contributing

This project is not accepting contributions at this time. It is intended solely for personal learning and exploration. However, feel free to clone the repository and use it as a learning resource.

Acknowledgments

• Could not have done this project without all the Tkinter tutorials by John Elder @flatplanet.

Screenshots

Frontispiece

Screenshot of Login page of Shelfie! app featuring No. 159 - "La Bibliothèque: Vue plongeante" by Erik Desmazières. Image taken from app interface (Personal Collection, 2022). In the public domain.