FrederikBaerentsen
/
ComicOPDS
1
0
Fork 0
Code Issues 9 Pull Requests Projects Releases Wiki Activity
ComicOPDS is a lightweight OPDS server written in Python and Flask that allows you to browse your cbz files using OPDS.
19 Commits 1 Branch 0 Tags 204 KiB
Python 91.2%
HTML 5.6%
Jinja 2.9%
Dockerfile 0.3%
Go to file
FrederikBaerentsen a04b119ce5 working on comicdb.xml import 2022-06-09 15:43:50 +02:00
opds Testing zip errors 2022-06-07 21:07:28 +02:00
static initial commit 2022-06-07 09:16:43 +02:00
Dockerfile initial commit 2022-06-07 09:16:43 +02:00
README.md updated note in readme with correct timed import of comics. The previous number was with lots of skipped comics 2022-06-07 22:03:40 +02:00
README.md.old Started new README with installation instructions 2022-06-07 16:51:19 +02:00
config.py pushed tentative fix for import 2022-06-07 21:44:57 +02:00
db.py working on comicdb.xml import 2022-06-09 15:43:50 +02:00
docker-compose.yml fixed zip issue (#1) 2022-06-07 21:59:03 +02:00
import.py added manual import test 2022-06-07 21:41:36 +02:00
main.py fixed zip issue (#1) 2022-06-07 21:59:03 +02:00
metadata.py initial commit 2022-06-07 09:16:43 +02:00
queryTest.py Starting json2query in catalog.py 2022-06-07 16:16:18 +02:00
requirements.txt removed gzip requirement 2022-06-07 21:46:09 +02:00
test.json Testing zip errors 2022-06-07 21:07:28 +02:00

README.md

ComicOPDS

ComicOPDS is a lightweight OPDS server written in Python and Flask that allows you to browse your cbz files using OPDS.

Getting Started

The easiest way to get started is to clone the git reposetory, build the docker image and run docker-compose.

Alternativly you can clone the repo and start the flask server using the main file. This requires a bit of configuration.

Prerequisites

  • All comic files needs to be cbz. This doens't work with cbr. I see no reason to use cbr and as such, this project wont support it.

  • All comics must be properly tagged. This means every cbz file must contain a ComicInfo.xml file. You can use various tools to

Docker

Prerequisites

  • Docker
  • Docker-compose

Installing

First clone the git repo.

git clone https://gitea.baerentsen.space/ComicOPDS

Then go to the folder

cd ComicOPDS

Next build the image

docker build . -t comicopds

Adjust the docker-compose file:

<add docker compose example with config options and drive mapping>

Run docker-compose

docker-compose up

Manual Install

To manually install the flask server you need to install the python requirements.

Prerequisites

  • Python3.x

Installing

python3 -m pip install -r requirements.txt

Change configs

In the config.py file you need to change like 4 from "/library" to your comic library. This has only been tested on Debian.

Running

python3 main.py

Notes

5865 files in 359 seconds