csv-library-website/README.md
2024-03-30 20:23:24 +01:00

34 lines
1011 B
Markdown

# csv-library-website
> Work in progress: this is a simple flask application that turns a csv file into a website.
> originally used to show books like in the [Varia Library Website](https://library.varia.zone/).. but it can be used for any collection described in the csv file
## Hacking
```
$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip install -r requirements.txt
```
Or run `make setup`.
```
$ cd library && python page.py
```
Or run `make`.
## major changes
* currently this software is broken.
## readme driven development
* add regular login instead of a secret key ✅
* have a settings file for the application ✅
* downloadable pdfs ✅
* uploadable pdfs
* upon boot check for images of the book otherwise extract front page of pdfs
* remove varia library specific code ✅
* implement [openlibrary](https://openlibrary.org/) ISBN to book in libarary software
* [openreads](https://github.com/mateusz-bak/openreads) ability to import this csv file
* maybe also GoodReads, BookWyrm