Skip to content

DOCUMENTATION.md

Latest commit

 

History

History
43 lines (31 loc) · 2.09 KB

DOCUMENTATION.md

File metadata and controls

43 lines (31 loc) · 2.09 KB

Pybrary Documentation

Project Overview

Pybrary is a library management system with a graphical user interface (GUI) that allows users to manage their collection of books. Users can enter book details such as title, author, year, pages, rating, and save them into a .csv file. The GUI displays a list of all books added to the .csv file and includes features for searching and visualizing data.

Features

  • Book Management: Add, delete, and search for books.
  • Data Visualization: Visualize book data by topic, author, rating, trends, and more using Matplotlib.

Installation Instructions

To install and set up the Pybrary project, follow these steps:

  1. Clone the Repository: 
    git clone https://github.com/PythonDataScience24/pybrary.git
cd pybrary
  2. Run the Application:
  • Simply execute pybrary.pyscript after cloning the GitHub project on your local device: python src/pybrary.py

Interacting with the GUI:

  • Add a Book: Fill in the book details (title, author, year, pages, rating) and click the "Add" button
  • Delete a Book: Select a book from the list and click the "Delete" button.
  • Search for Books: Use the search bar to find books by title, author, or other criteria. Click the "Search" button to apply the search.
  • Data Visualization: Navigate to the second tab of the GUI. Select what you want to visualize (e.g., by topic, author, rating, trends) using the buttons and then press "Go" to generate the visualizations.

Contributing Guidelines

We welcome contributions to the Pybrary project! For detailed guidelines on how to contribute, please refer to the CONTRIBUTING.md file in the repository.

Other important documentation files available in the repository include:

README.md: General overview and setup instructions. ROADMAP.md: Project roadmap and future plans. EXCEPTIONS.md: Exception handling details. TESTING.md: Information on how to run tests. CHANGES.md: Details on changes and updates to the project. LICENSE: Licensing information. CODE_OF_CONDUCT.md: Code of conduct for contributing to the project.