mirrors/calibre-web
1
0
Fork 0
mirror of https://github.com/janeczku/calibre-web synced 2025-04-23 11:13:11 +00:00
Code Issues Releases Wiki Activity

Added how to generate metadata provider

Ozzieisaacs 2022-04-17 10:35:24 +02:00
parent c833817748
commit 171d5914ad
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Developer.md Normal file

@ -0,0 +1,17 @@
# Developer's corner
## Add metadata provider
Calibre-Web will not be extended by any more metadata providers to download books metadata, but anybody is free to generate its own metadata provider and make it available to the publicity.
Generate a new .py file in the `cps/metadata_provider`. The file will be read during the next start of Calibre-Web. The file has to have a calss derived from `Metadata` and has to have a method named `search` returning a list of `MetaRecord`. Working examples can be found in the metadata_provder folder.
## Exclude files from beeing overwritten during update
If you have extended Calibre-Web somehow with new files this files will be overwritten during the next manual run of programm internal updater.
To prevent this, add your files in the `exclude.txt` file in the root directory of Calibre-Web. Please use one file or directory per line. Calibre-Web's root folder acts as root folder for this file. **/** or **\** can act as path seperators, pathes with spaces can be enclosed by **"** or **'**. Per default all Calibre-Web settings databases and default logfiles are excluded from beeing overwritten.\
Examples:\
`/logfile`\
Will exclude a file or a folder named **logfile** from beeing overwritten during update process.\
`/random path/except.txt`\
Will exclude a file named **except.txt** in the random path directory from beeing overwritten during update process.\
To check if anything works out well a dry run of the updater can be started by starting Calibre-Web with the `-d` parameter. Calibre-Web will check beside several other stuff if all files in exclude.txt are available.