https://github.com/puhoy/lspace
a cli ebook manager
https://github.com/puhoy/lspace
cli ebook ebook-manager epub pdf
Last synced: 5 months ago
JSON representation
a cli ebook manager
- Host: GitHub
- URL: https://github.com/puhoy/lspace
- Owner: puhoy
- License: agpl-3.0
- Created: 2019-05-11T20:21:51.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T11:09:32.000Z (10 months ago)
- Last Synced: 2024-12-13T03:42:26.399Z (5 months ago)
- Topics: cli, ebook, ebook-manager, epub, pdf
- Language: Python
- Homepage:
- Size: 678 KB
- Stars: 30
- Watchers: 3
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# l-space
a cli ebook manager built around [isbnlib](https://github.com/xlcnd/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.
[](https://travis-ci.org/puhoy/lspace)
[](https://codecov.io/gh/puhoy/lspace)
## requirements
python >=3.5 and pip
## installation
#### from pypi (latest release)
`pip install lspace`
#### from github (probably-not-so-stable-dev-stuff)
`pip install git+https://github.com/puhoy/lspace.git`
## setup
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
```
#### database path
path to your database.
the project uses sqlalchemy, so all databases supported by sqlalchemy should be fine.
#### file_format
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
#### library path
where the imported files are stored
#### loglevel
the default python loglevels (debug, info, error, exception)
#### default_{shelf, author, language, publisher}
the default field names, in case nothing is specified in import
## usage
### importing
`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`
#### import from calibre library
`lspace import path/to/calibre_library/metadata.db`
#### import from lspace api
`lspace import http:///api/v1/`
the web interface (`lspace web` - scroll down a bit!) generates import strings based on your search!
### searching your library
`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
### removing stuff
`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]:
### exporting books
`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](https://calibre-ebook.com/)!
### browse & share your books via webserver
`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..)
## setting up a dev env
#### 1. clone this repo
#### 2. make a virtualenv and activate it
```bash
python -m venv env
source env/bin/activate # for bash
# or
#. env/bin/activate.fish # for fish
```
#### 3. install requirements
```bash
pip install -e .[dev]
```
#### 4. set up a separate config to not mess up your regular installation
```bash
# 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
```bash
export LSPACE_CONFIG=~/.config/lspace_dev/config.yml # bash
set -gx LSPACE_CONFIG ~/.config/lspace_dev/config.yml # fish
```
#### migrations
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
#### making a release
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.
## why "L-space"?
its named after discworlds [library-space](https://en.wikipedia.org/wiki/List_of_dimensions_of_the_Discworld#L-space) dimension :)