a cli ebook manager built around isbnlib
on import, lspace tries to find isbns in the files metadata and in the text. with the isbn it tries to fetch metadata about the book from google books and openlibrary. if no isbn is found, it queries metadata based on the filename.
after this, your properly renamed files will be stored in your library folder.
currently supports epub and pdf.
python >=3.5 and pip
pip install lspace
pip install git+https://github.com/puhoy/lspace.git
after installation, you should run
lspace init
this will setup a new configuration file, which you can edit to specify the structure of your library, for example.
a default config file would look like this:
database_path: sqlite:////home/USER/.config/lspace/lspace.db
file_format: '{SHELF}/{AUTHORS}_{TITLE}'
library_path: ~/library
loglevel: error
default_shelf: misc
default_author: no author
default_language: no language
default_publisher: no publisher
path to your database. the project uses sqlalchemy, so all databases supported by sqlalchemy should be fine.
template string for storing the plain files in the library.
{SHELF}/{AUTHORS}_{TITLE} would produce files like scifi/cixin-liu_three-body-problem.epub
author and title will be automatically slugified for this.
possible variables to use are: AUTHORS, TITLE, SHELF, YEAR, LANGUAGE, PUBLISHER
where the imported files are stored
the default python loglevels (debug, info, error, exception)
the default field names, in case nothing is specified in import
lspace import path/to/ebook.epub
lspace import path/to/folder/*
if you already have a folder you are happy with and, for example, just want to use it to serve your books or search through your files, you can add the --inplace switch on import, which will not copy them over to your library folder, but instead keep the book as an "external" reference.
lspace import --inplace path/to/ebook.epub
lspace import path/to/calibre_library/metadata.db
lspace import http://<some-address>/api/v1/
the web interface (lspace web - scroll down a bit!) generates import strings based on your search!
lspace list QUERY [--path]
for example,
lspace list programming --path
would return something like
/home/USER/library/donald-e-knuth/art-of-computer-programming-volume-2.pdf
/home/USER/library/donald-e-knuth/the-art-of-computer-programming-volume-1-fascicle-1.pdf
and
lspace list dwarf
would return return
Peter Tyson - Getting Started With Dwarf Fortress
lspace remove QUERY
this command will ask you before it actually deletes stuff :)
Peter Tyson - Getting Started With Dwarf Fortress
/home/USER/library/peter-tyson/getting-started-with-dwarf-fortress.epub
delete this book from library? [y/N]:
lspace export QUERY ~/some/folder/ --format mobi
would convert all books matching on QUERY to 'mobi' and export them to ~/some/folder
to actually export to another format, you need "ebook-convert", which is part of calibre!
lspace web --host 0.0.0.0 --port 5000
this also gives you the import command for your current search results!
(or you can just download them manually..)
python -m venv env
source env/bin/activate # for bash
# or
#. env/bin/activate.fish # for fishpip install -e .[dev]# initialize a new config file at a separate path
LSPACE_CONFIG=~/.config/lspace_dev/config.yml lspace init
# change the database and library path! (otherwise it would still use the regular db)
sed -i 's/lspace\/lspace.db/lspace_dev\/lspace.db/g' ~/.config/lspace_dev/config.yml
sed -i 's/~\/library/~\/library_dev/g' ~/.config/lspace_dev/config.yml
# also, if you want, set the loglevel to something else
after this, just set LSPACE_CONFIG to your new config file before you start to try new stuff
export LSPACE_CONFIG=~/.config/lspace_dev/config.yml # bash
set -gx LSPACE_CONFIG ~/.config/lspace_dev/config.yml # fish the db command is available when running in dev mode.
create a new migration with LSPACE_DEV=1 lspace db migrate
afterwards, running any lspace command will automatically update the database
commands to build, test-release and release are wrapped in a doit script dodo.py.
bumping is requires bump2version, twine is used for uploading to pypi.
its named after discworlds library-space dimension :)