Skip to content

index.rst

Latest commit

 

History

History
554 lines (394 loc) · 15.9 KB

index.rst

File metadata and controls

554 lines (394 loc) · 15.9 KB

Library Management System

The Library Management System is a Django-based web application that offers a digital platform for managing and interacting with a library's collection. It streamlines the processes of book lending, returns, and inventory management, while ensuring easy access for users and librarians alike. Through this system, users can search for available books, place borrowing requests, and manage their borrowed items. Librarians, on the other hand, oversee the addition, update, and removal of book records, and can approve or decline borrowing requests. The system also supports diverse user roles, from regular members to staff and administrators, each with distinct capabilities.

A well-structured user interface ensures that all functionalities are easily accessible, making the library management process seamless and efficient. This project aims to merge traditional library functions with modern technological innovations, promoting efficiency and an enhanced user experience.

User roles

Note

It is essential for developers to consider security aspects when implementing these roles to ensure that users cannot perform actions outside their designated role's scope.

Admins

Superusers have full control over the entire system. They can access and manage all functionalities provided by the Django admin site.

Admins can create, modify, or delete any record within the application.

Capabilities

  • Access Django admin site

Librarians

Staff personnel are in charge of day-to-day operations within the library. They can add new books to the library's collection, manage existing books' details, and accept or decline borrow requests from regular users.

Capabilities

  • Management of the library catalogue
    • Add, modify or delete authors
    • Add, modify or delete genres
    • Add, modify or delete books' details
  • Review borrow requests from regular users
  • Accept or decline borrow requests
  • Register returned books and update their status

Regular

Regular registered users are the members of the library. They can search books, request to borrow them, and are responsible for returning borrowed books on time.

Capabilities

  • Browse the books' catalogue
  • View details of a book
  • Search books
  • Request to borrow available books
  • Check due date for returned books
  • Return borrowed books

Anonymous

Anonymous users are visitors who haven't logged into the system.

Capabilities

  • Browse the books' catalogue
  • View details of a book
  • Search books
  • Access to the registration or login pages

Models

Author model

The Author model captures the details of the person, or group responsible for creating the book.

Attributes

Name:The full name of the author. This should be limited to 255 characters.
Bio:A brief biography or description of the author.

Genre model

The Genre model represents the category or type of content a book belongs to, such as "Fiction", "Non-fiction", "Science", "Romance" etc. Since a book can belong to more than one category at a time, it is implemented as a dedicated model.

Attributes

Name:The name of the genre.

Book model

The Book model represents a physical book in the library's collection. Each book record captures essential bibliographic information, as well as details related to its current status in the library (e.g. available, borrowed etc.).

Attributes

Title:The name or title of the book (255 characters or fewer).
Summary:A brief description or synopsis of the book.
ISBN:International Standard Book Number, a unique identifier for books.
Available:Current available status of the book. Either True or False. Books are available by default.
Published date:The date when the book was published.
Publisher:The entity or company responsible for the production and distribution of the book.
Genre(s):The category or type of content the book falls under (e.g., Fiction, Non-Fiction, Science).
Author(s):The name of the person or group responsible for creating the content of the book.
Borrower:The user who has currently borrowed the book, if applicable.

Borrow request model

The BorrowRequest model captures the intent of a user to borrow a specific book. It tracks the status of the request, whether it's pending, approved, declined, or completed.

Attributes

Book:

A reference to a book to be borrowed.
Borrower:

A reference to a user who wants to borrow a book.
Status:

The current status of the request.

  • pending
  • approved
  • collected
  • complete
  • declined

The status constants should be encapsulated within the BorrowRequest model.

class BorrowRequestModel(models.Model):
    ...
    PENDING = 1
    APPROVED = 2
    COLLECTED = 3
    COMPLETE = 4
    DECLINED = 5
    ...
Overdue:

A flag indicating if a borrow request was overdue.
Request date:

The date the borrow request was made. This is required.
Approval date:

The date the request was approved, if applicable. Optional.
Due date:

The date by which the book should be returned. Optional, should only be set if the request if approved.
Complete date:

The date the book was returned and the borrowing request was completed. Optional, should only be set if the request has reached the "Complete" status.

Relationships

.. mermaid:: ./mermaid/models.mmd
    :align: center
    :caption: Entity relationship diagram
    :alt: entity relationship diagram

Book to author

Each Author can be associated with multiple Books, and each Book can have one or more authors. This establishes a many-to-many relationship between the two entities.

Book to genre

Each Genre can be associated with multiple Books, and vice-versa. However a Book might not belong to any genre. This relationship between Genre and Book is still considered many-to-many, but with the possibility of zero genres for a book.

Book to borrow request

Each Book can be associated with multiple BorrowRequests, but each BorrowRequest refers only one book, forming a many-to-one relationship.

User to borrow request

Each User can make multiple BorrowRequests, but each BorrowRequest refers to only one book, forming a many-to-one relationship.

User to book (as a borrower)

A Book may have been borrowed by a User, but at any given time, each Book can be borrowed by one user only. This forms a one-to-one relationship.

Views and templates

Admin site

Admin site provides the full control over the entire system. Only admins are permitted to use admin site. Librarians should use their dedicated views to perform operations, except special cases.

Authentication

Login

Template

A form with fields for entering a username and a password, and a submit button.

View logic

Validate entered credentials and authenticate the user. In case of incorrect credentials, display an error message.

Registration

Template

A form for new user registration. Required fields are:

  • username
  • first name
  • last name
  • password
  • confirm password

View logic

Upon submission, the view should validate the provided data:

  • Check if username is already taken.
  • Ensure that password and confirm password fields match.
  • Save the user's data if all validations pass. Otherwise, display appropriate error messages.

When saving passwords in the database, always store them in a hashed format, never in plain text.

Hint

Django's built-in User model and authentication system handle password hashing by default, which is a big plus.

Borrowing History

This view is available only for authenticated users.

Template

Users can see the list of all their borrows requests, regardless of approve/decline status.

View logic

  • Authenticated users can see only their own borrow requests.
  • Librarians and admins can access borrows requests list for any user, registered in the library system.

Library collection

These views are generally available for all (including anonymous) users. The functionality for authenticated users include books borrowing.

Books list

Template

A list (or table) of books. Each book entry should provide information:

  • title
  • author(s)
  • summary (truncated if too long, 30 words or fewer)
  • availability status (either Available or Unavailable)

View logic

  1. Querying the data

    • Fetch all books from the database

  2. Checking availability status (visual mark)

    • For each book, determine its availability status. Check Book.available flag.

    Note

    A user can still create a borrowing request, regardless of the book availability status. This is only the visual mark.

Detail view

Template

The detailed view of a specific book, presenting comprehensive information:

  • Title: Display the book's title prominently.
  • Genre(s): List all associated genres (if any).
  • Author(s): List all associated authors.
  • ISBN: The International Standard Book Number.
  • Published Date: When the book was published.
  • Publisher: The name of the entity or company responsible for publishing
  • Summary: A full summary or description of the book. the book.
  • Action Buttons (For authenticated users only):
    • Borrow Request Button: If the user has no associated borrow request they can create a new one.
    • Gather Book Button: If the user's borrow request for this book has been approved, allow the user to confirm they've picked up the book.

View logic

  1. Fetching Book Details:
    • Use the book's identifier (usually a primary key) to fetch its details from the database.
  2. Checking User Authentication:
    • Determine if a user is authenticated. If they are, display the appropriate action buttons based on the book's availability status and any existing borrow requests by the user.
  3. Handling Borrow Requests:
    • If an authenticated user clicks on the "Borrow Request" button:
      1. Create a new borrow request in the BorrowRequest model with status "pending".
      2. Update the book's status to "Awaiting approval".
      3. Redirect the user to a confirmation page or display a message indicating the request has been made.
  4. Handling Book Gathering:
    • If an authenticated user has an approved borrow request and clicks the "Gather Book" button:
      1. Update the book's status to "Borrowed".
      2. Update the borrow request's status to "complete".
      3. Redirect the user to a confirmation page or display a message indicating they've picked up the book.

Note

Always ensure the user's actions are authenticated and authorized. This prevents unauthorized borrow requests or gathering of books. Also, consider adding error handling to manage cases where the book's details cannot be fetched or any other unexpected issues.

Books management

These views are available only for staff (librarians and admins).

Authors and genres management

Only librarians and admins can add, modify or delete authors and genres. No additional views for CRUD operations required (except admin site). Librarians are allowed to access authors and genres via admin site. Only admins can remove authors or genres.

Book creation and update

The template should comprise a form with fields corresponding to the book's attributes. Here are the essential elements for the form:

Title:A text input field.
Summary:A textarea for a brief description or synopsis.
ISBN:A text input field for the book's International Standard Book Number.
Available:A checkbox indicating if a book is available. Defaults to True.
Published date:A date input field.
Publisher:A text input field.
Genres:A multi-select list of genres (e.g. dropdown, checkboxes etc.). This should fetch available genres from the database and allow users to select zero or more genres.
Authors:A multi-select list of authors (e.g. dropdown, checkboxes etc.). This should fetch available authors from the database and allow users to select one or more authors.

View logic

  • If it's an update action, pre-populate the form fields with the existing details of the book fetched from the database.
  • For creation, provide an empty form for the librarian to fill in.
  • Ensure the published date is logical (e.g. not a future date).
  • Validate required inputs, according to general Book model rules.
  • If validations pass: save changes to the database; otherwise, provide helpful error messages.

Note

You MAY provide a mechanism (like modal or a quick entry form) to add a new genre or author without leaving the book form page.

Book deletion

Only librarians and administrators are permitted to perform this action.

Template

A confirm delete form with Submit and Cancel buttons.

View logic

  • Authorize user before deleting performing deletion.
  • If a form is submitted, a book should be removed from the library collection.
  • If deletion is canceled view should redirect back to book detail view page.

Borrow requests

This view facilitates the management of borrowing requests for librarians and admins, aiding in their prompt handling.

Template

Present a table showcasing the list of borrow requests. Each row embodies a borrow request and encompasses:

  • Book Title: Title of the requested book.
  • User: Identifier of the user who initiated the request.
  • Request Date: Date of the request's inception.
  • Due Date: - Input field for librarians to set upon approval for new requests. - For approved ones, display the librarian-set date.
  • Status: Present state of the request (New, Approved, Completed, Declined).
  • Approve Button: Visible for new requests. Toggles status to "Approved" and freezes the due date.
  • Decline Button: Appears for new requests. Sets status to "Declined" and can prompt for a decline reason.
  • Complete Button: Displayed for approved requests. Marks the request as completed.

View Logic

  1. Approve Borrow Request: - Validate book availability. - Modify book status to "Borrowed". - Switch borrow request to "Approved". - Define the return due date as per librarian. - Inform the user about the approval and due date.
  2. Decline Borrow Request: - Change borrow request status to "Declined". - Optionally, procure decline reason from librarian. - Notify user regarding the declination.
  3. Complete Borrow Request: - Ensure book's return. - Update book status to "Available". - Toggle borrow request status to "Completed". - If needed, record any notes or damages during return.

Note

Implementing reminders for near-due borrow requests can function as an alert system for both the librarian and the user.