Library Service API

Welcome to the Library Management Service API! This API is a Django-based web application designed to modernize and automate the management of book borrowings, payments, and notifications for a library. The system optimizes the work of library administrators and enhances the user experience.

To provide an even better user experience, we have integrated a Telegram bot for real-time notifications. Our Telegram bot is responsible for notifying users about the following events:

New Borrowing: Users will receive a notification when they successfully create a new borrowing, providing details about the borrowed book and the due date.

Successful Payment: Upon successful payment for a borrowing or fine, users will receive a notification confirming the payment, including relevant details.

To enable Telegram notifications, users need to set up their Telegram account within the Library Management Service. This feature ensures that users stay informed and up-to-date on their library activities through the convenience of Telegram.

Getting Started

Prerequisites

Before you begin, make sure you have the following tools and technologies installed:

• Docker

How to install Docker

Installing / Getting started

A quick introduction of the setup you need to get run a project.

Using Git

1. Clone the repo:

git clone https://github.com/petrykivd/library-service-api

2. You can open project in IDE and configure .env file using .env.sample file as an example.

Parameters for .env file:

• STRIPE_SECRET_KEY: Your Stripe Secret Key
• BOT_TOKEN: Your Bot Token
• ADMIN_GROUP: Your Admin Group in Telegram
• TURN_BOT_ON: True/False
• POSTGRES_DB: Your Postgres DB
• POSTGRES_USER: Your Postgres User
• POSTGRES_PASSWORD: Your password in DB
• POSTGRES_HOST Host of your DB
• POSTGRES_HOST Port of your DB

3. Run docker-compose command to build and run containers:

docker-compose up --build

To access browsable api, use http://localhost:8000/api/

To get access to the content, visit http://localhost:8000/api/user/token/ to get JWT token.

Use the following admin user:

• Email: [email protected]
• Password: 12345

4. Setup Telegram Bot

   You must add admin Chat ID and Initialize Chat to take notification to Telegram.

How to

Create bot in Bot Father

• Start chat with Bot Father
• /newbot - to create new bot
• Send bot's name
• /setprivacy - change to Disable
• Copy and save API Key, Bot Link

Create chat

• You need to create channel
• Than, you should add your bot using Bot Link

Find chat id

• Write some message in chat
• Go to https://api.telegram.org/bot<TOKEN>/getUpdates.
• In <TOKEN> place API Key
• You will get response:

  "chat": {
"id": -4017738106,
"title": "Order Tickets",
"type": "group",
"all_members_are_administrators": true
},

• Save your Chat ID

• Write all saved information inside .env file like that:

• BOT_TOKEN=BOT_TOKEN

• ADMIN_GROUP=ADMIN_GROUP

API Endpoints

Books

• List Books: GET /api/books/
• Create Book: POST /api/books/
• Retrieve Book: GET /api/books/{book_id}/
• Update Book: PUT /api/books/{book_id}/
• Partial Update PATCH /api/books/{book_id}/
• Delete Book: DELETE /api/books/{book_id}/
• Upload Astronomy Show Image: POST /api/books/{book_id}/upload-image/

Borrowings

List Borrowings: GET /api/borrowings/

• Create Borrowing: POST /api/borrowings/
• Retrieve Borrowing: GET /api/borrowings/{borrowing_id}/
• Update Borrowing: PUT /api/borrowings/{borrowing_id}/
• Partial Update PATCH /api/borrowings/{borrowing_id}/
• Delete Borrowing: DELETE /api/borrowings/{borrowing_id}/

Payments

• List Payments: GET /api/payments/
• Retrieve Payment: GET /api/payments/{payment_id}/
• Create Payment: POST /api/payments/
• Update Payment: PUT /api/payments/{payment_id}/
• Partial Update PATCH /api/payments/{payment_id}/
• Delete Payment: DELETE /api/payments/{payment_id}/

User

- **Information about current User**: `GET /api/user/me/` - **Update User**: `PUT /api/user/me/` - **Partial Update** `PATCH /api/user/me/` - **Create new User** `POST /api/user/register/` - **Create access and refresh tokens** `POST /api/user/token/` - **Refresh access token** `POST /api/user/token/refresh/` - **Verify tokens**: `POST /api/user/token/verify/`

Authentication

• The API uses token-based authentication for user access. Users need to obtain an authentication token by logging in.
• Administrators and authenticated users can access all endpoints, but only administrators can change information about books, borrowings, and related entities. Each authenticated user can access and create their own borrowings.

Documentation

• The API is documented using the OpenAPI standard.
• Access the API documentation by running the server and navigating to http://localhost:8000/api/doc/swagger/ or http://localhost:8000/api/doc/redoc/.

DB Structure

Contributing

Feel free to contribute to these enhancements, and let's make our Library Management Service API even better!

License

This project is licensed under the MIT License.