py-ebooktools 0.1.0a3

Installation

1. It is highly recommended to install the package py_ebooktools in a virtual environment using for example venv or conda.

2. Make sure to update pip:

   $ pip install --upgrade pip

3. Install the package py_ebooktools (bleeding-edge version) with pip:

   $ pip install git+https://github.com/raul23/py-ebooktools#egg=py-ebooktools

Warning

Make sure that pip is working with the correct Python version. It might be the case that pip is using Python 2.x You can find what Python version pip uses with the following:

$ pip -V

If pip is working with the wrong Python version, then try to use pip3 which works with Python 3.x

Test installation

1. Test your installation by importing py_ebooktools and printing its version:

   $ python -c "import py_ebooktools; print(py_ebooktools.__version__)"

2. You can also test that the script ebooktools.py runs by showing the program’s version:

   $ ebooktools --version

Usage, options and configuration

All of the options documented below can either be passed to the ebooktools.py script via command-line parameters or via the configuration file config.py. Command-line parameters supersede variables defined in the configuration file. Most parameters are not required and if nothing is specified, the default value defined in the default config file default_config.py will be used.

Uninstall

To uninstall the package py_ebooktools:

$ pip uninstall py_ebooktools

Information

When uninstalling the py_ebooktools package, you might be informed that the configuration files logging.py and config.py won’t be removed by pip. You can remove those files manually by noting their paths returned by pip. Or you can leave them so your saved settings can be re-used the next time you re-install the package.

Example: uninstall the package and remove the config files

$ pip uninstall py_ebooktools
Found existing installation: py-ebooktools 0.1.0
Uninstalling py-ebooktools-0.1.0:
  Would remove:
    /Users/test/miniconda3/envs/ebooktools_py37/bin/ebooktools
    /Users/test/miniconda3/envs/ebooktools_py37/lib/python3.7/site-packages/py_ebooktools-0.1.0.dist-info/*
    /Users/test/miniconda3/envs/ebooktools_py37/lib/python3.7/site-packages/py_ebooktools/*
  Would not remove (might be manually added):
    /Users/test/miniconda3/envs/ebooktools_py37/lib/python3.7/site-packages/py_ebooktools/configs/config.py
    /Users/test/miniconda3/envs/ebooktools_py37/lib/python3.7/site-packages/py_ebooktools/configs/logging.py
Proceed (y/n)? y
  Successfully uninstalled py-ebooktools-0.1.0
$ rm -r /Users/test/miniconda3/envs/ebooktools_py37/lib/python3.7/site-packages/py_ebooktools/

Roadmap

• Port all of ebook-tools shell scripts into Python

  • organize-ebooks.sh: not started yet

  • interactive-organizer.sh: not started yet

  • find-isbns.sh: working on it

  • convert-to-txt.sh: working on it

  • rename-calibre-library.sh: not started yet

  • split-into-folders.sh: done, see split_into_folders.py

• Add tests

• Eventually add documentation on readthedocs

References

• ebook-tools: Shell scripts for organizing and managing ebook collections.

License

This program is licensed under the GNU General Public License v3.0. For more details see the LICENSE file in the repository.