{"id":19405414,"url":"https://github.com/lakshyakhatri/bookshelf-reader-api","last_synced_at":"2025-04-24T09:30:55.546Z","repository":{"id":129708672,"uuid":"177996958","full_name":"LakshyaKhatri/Bookshelf-Reader-API","owner":"LakshyaKhatri","description":"A browsable REST API for recognizing book spines in an image.","archived":false,"fork":false,"pushed_at":"2021-01-16T18:36:17.000Z","size":6305,"stargazers_count":45,"open_issues_count":3,"forks_count":17,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-03T01:51:12.993Z","etag":null,"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"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LakshyaKhatri.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-27T13:10:05.000Z","updated_at":"2024-09-26T02:45:10.000Z","dependencies_parsed_at":"2023-04-06T04:32:54.170Z","dependency_job_id":null,"html_url":"https://github.com/LakshyaKhatri/Bookshelf-Reader-API","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LakshyaKhatri%2FBookshelf-Reader-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LakshyaKhatri%2FBookshelf-Reader-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LakshyaKhatri%2FBookshelf-Reader-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LakshyaKhatri%2FBookshelf-Reader-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LakshyaKhatri","download_url":"https://codeload.github.com/LakshyaKhatri/Bookshelf-Reader-API/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250600558,"owners_count":21456985,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["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"],"created_at":"2024-11-10T11:38:11.908Z","updated_at":"2025-04-24T09:30:55.530Z","avatar_url":"https://github.com/LakshyaKhatri.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bookshelf-Reader-API\nA browsable REST API built using Django REST Framework for recognizing book spines in an image.\n\nUploaded Image        | Result\n:--------------------:|:---------------------------:\n\u003cimg src=\"assets/spines.jpg\" alt=\"Uploaded Image\" width=\"300\" /\u003e|\u003cimg src=\"assets/drawn_spines.jpeg\" alt=\"Resulted Image\" width=\"300\" /\u003e\n\n# Installation\n* To run this project locally, clone or download this repository.\n* Install requirements using:\n    ```\n    pip install -r requirements.txt\n    ```\n* Then run the migrations using:\n    ```\n    python3 manage.py makemigrations  \n    python3 manage.py migrate\n    ```\n* Run the application:\n    ```\n    python3 manage.py runserver\n    ```\n\n# Usage\nAdd these URLs after your landing URL\n\nFunction                | url                    | Return  \n:----------------------:|:----------------------:|:----------------------------------------------------:  \nUpload Bookshelf Image  | `/api/create-bookshelf/` | ID for referring the uploaded image (Inside the Response Header)  \nSpine Line Drawn Image  | `/api/bookshelf/\u003cbookshelf-id\u003e/` | Spine line drawn image\nCropped Spines          | `/api/spines/\u003cbookshelf-id\u003e/` | URLS of the cropped spine images\n\n# Further Implementation\n\nThis 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.\n\n\u003e *NOTE 1:* It's okay if the recognized text is not accurate. The scrapper will automatically find the correct book.  \n\u003e *NOTE 2:* The uploaded text is expected to be the book title \\[and author name\\].\n\nFunction                | url                    | Return  \n:----------------------:|:----------------------:|:----------------------------------------------------:  \nUpload book title text for scrapping information  | `/api/add-book/` | ID of the created Book object (Inside the Response Header)\nGet Book Information | `/api/book/\u003cbook-id\u003e/` | Scrapped book information.\n\n# Client Side Application\nIf 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)\n\n# Liscence\nMIT License\n\nCopyright (c) 2020 Lakshya Khatri\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flakshyakhatri%2Fbookshelf-reader-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flakshyakhatri%2Fbookshelf-reader-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flakshyakhatri%2Fbookshelf-reader-api/lists"}