https://github.com/lakshyakhatri/bookshelf-reader-api
A browsable REST API for recognizing book spines in an image.
https://github.com/lakshyakhatri/bookshelf-reader-api
api book book-information book-scrapper book-spider book-spine book-spine-detection book-spines bookshelf bookshelf-reader-api data-scraping recognizing-book-spines rest-api rest-apis restful-api scrappers scrapping spine-detection spine-recognition spines
Last synced: about 1 month ago
JSON representation
A browsable REST API for recognizing book spines in an image.
- Host: GitHub
- URL: https://github.com/lakshyakhatri/bookshelf-reader-api
- Owner: LakshyaKhatri
- License: mit
- Created: 2019-03-27T13:10:05.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-01-16T18:36:17.000Z (over 4 years ago)
- Last Synced: 2025-04-03T01:51:12.993Z (2 months ago)
- Topics: api, book, book-information, book-scrapper, book-spider, book-spine, book-spine-detection, book-spines, bookshelf, bookshelf-reader-api, data-scraping, recognizing-book-spines, rest-api, rest-apis, restful-api, scrappers, scrapping, spine-detection, spine-recognition, spines
- Language: Python
- Homepage:
- Size: 6.01 MB
- Stars: 45
- Watchers: 3
- Forks: 17
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bookshelf-Reader-API
A browsable REST API built using Django REST Framework for recognizing book spines in an image.
Uploaded Image | Result
:--------------------:|:---------------------------:
|
# Installation
* To run this project locally, clone or download this repository.
* Install requirements using:
```
pip install -r requirements.txt
```
* Then run the migrations using:
```
python3 manage.py makemigrations
python3 manage.py migrate
```
* Run the application:
```
python3 manage.py runserver
```
# Usage
Add these URLs after your landing URL
Function | url | Return
:----------------------:|:----------------------:|:----------------------------------------------------:
Upload Bookshelf Image | `/api/create-bookshelf/` | ID for referring the uploaded image (Inside the Response Header)
Spine Line Drawn Image | `/api/bookshelf//` | Spine line drawn image
Cropped Spines | `/api/spines//` | URLS of the cropped spine images
# Further Implementation
This project contains scrappers to scrap the information of all the books recognized in the spine image. Recognized spine can be sent for text recognition and then the recieved text can be uploaded to below URL's for scrapping the book's information.
> *NOTE 1:* It's okay if the recognized text is not accurate. The scrapper will automatically find the correct book.
> *NOTE 2:* The uploaded text is expected to be the book title \[and author name\].
Function | url | Return
:----------------------:|:----------------------:|:----------------------------------------------------:
Upload book title text for scrapping information | `/api/add-book/` | ID of the created Book object (Inside the Response Header)
Get Book Information | `/api/book//` | Scrapped book information.
# Client Side Application
If you want to see how this REST API can be used at client side then checkout [Bookshelf Reader Android Application](https://github.com/LakshyaKhatri/Bookshelf-Reader)
# Liscence
MIT License
Copyright (c) 2020 Lakshya Khatri
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.