https://github.com/sio/homelibrarycatalog
Web application for cataloging home books collection
https://github.com/sio/homelibrarycatalog
Last synced: 28 days ago
JSON representation
Web application for cataloging home books collection
- Host: GitHub
- URL: https://github.com/sio/homelibrarycatalog
- Owner: sio
- License: gpl-3.0
- Created: 2017-04-23T10:41:28.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-05-05T13:03:48.000Z (almost 2 years ago)
- Last Synced: 2025-02-08T00:41:14.667Z (3 months ago)
- Language: Python
- Size: 346 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# HomeLibraryCatalog
Web application for cataloging home books collection
## Installation and usage
Installation:
* `pip install https://github.com/sio/HomeLibraryCatalog/tarball/master` to install
directly from GitHub *or*
* download release archive, and install with `pip install ` *or*
* download release archive, unpack it and start `HomeLibraryCatalog.py`
To launch HomeLibraryCatalog with wsgiref web server run
`HomeLibraryCatalog config.json` where *config.json* is the
[configuration file][1]. If no command line arguments are supplied,
*hlc.config* in current working directory is used.
Check [this article][2] for further information on HomeLibraryCatalog
deployment with wsgiref and/or other WSGI compatible web servers.
Step-by-step deployment instructions are described in this [Ansible playbook].
[1]: docs/configuration.md
[2]: docs/deployment.md
[Ansible playbook]: https://gitlab.com/sio/server_common/tree/master/ansible/roles/morebooks
## Requirements
* **python3** with following packages (available via `pip install`)
* **bottle** - micro web framework with built-in simple web server
* **pillow** - image manipulation library
* **lxml** with **cssselect** - HTML scraping library
* **wtforms** - web forms generator
## Localization status
As of now all user interaction happens in Russian
Localization is not planned in the foreseable future due to the lack of human
resources
Proper localizations tools and techniques (gettext et al) are not yet supported
## Contributing
All contributions are welcome!
Please check [CONTRIBUTING.md](CONTRIBUTING.md) for details
## License and copyright
Copyright © 2016-2019 Vitaly Potyarkin
```
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
```
## Todo list
#### WebUI:
- [ ] Barcode queue:
- [ ] fetch related information in background, store to title field
- [ ] show title and user on /queue page
- [ ] Forms:
- [ ] for registered users
- [ ] author rating
- [ ] book not in library anymore
- [ ] password change: force if expired
- [ ] for administrators
- [ ] edit groups
- [ ] for all visitors
- [ ] advanced search: single field searches
- [ ] start page: greetings/newest books/thumbnail gallery?
- [ ] Pages:
- [ ] annotated list with previews
- [ ] available books
- [ ] future books (to buy)
- [ ] recent books with thumbnails (last month, prev-next links)
- [ ] one book
- [ ] external links
- [ ] more information?
- [ ] one author
- [ ] wikipedia link
- [ ] series "foo"
- [ ] other books by year
- [ ] authors/series list
- [ ] CSS:
- [ ] dark background, light page
- [ ] no #000000
- [ ] narrow pages
- [ ] stylesheet themes
- [ ] robots.txt file
- [ ] garbage collector for ThreadItemPool
#### Auto fetcher:
- [ ] more sources:
- [ ] Wordcat
- [ ] Ozon
- [ ] Google Books?
#### Database:
- [ ] add garbage collector method (delete orphaned thumbnails, authors, etc.)