Metadata-Version: 2.0
Name: BookCut
Version: 1.3.7
Summary: Command Line Interface app to download ebooks.
Home-page: https://github.com/costis94/bookcut
Author: Costis94
Author-email: gravitymusician@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >3.5.2
Description-Content-Type: text/rst
Provides-Extra: dev
License-File: LICENSE.txt
Requires-Dist: pandas
Requires-Dist: click (>=7.1.2)
Requires-Dist: requests
Requires-Dist: beautifulsoup4
Requires-Dist: pyfiglet
Requires-Dist: tqdm
Requires-Dist: mechanize
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: black; extra == 'dev'

.. figure:: https://i.imgur.com/ZUX2ehE.png
   :alt: 

|Downloads| |pypi|

BookCut is a Python Command Line Interface tool, that help the user to
download **free e-books**, **organise** them in folders by genre,
**retrieve** book details by *ISBN* or *title*, get a list with **all
the books from a writer** and save them to .txt file.

*With the help of LibGen, ArXiv and OpenLibrary.*

REQUIREMENTS
============

-  Python 3
-  python3-pip

Installation
============

-  **Install with pip:**

.. code:: bash

    pip install bookcut
    #or if you have also Python 2
    pip3 install bookcut

Usage
=====

Searching and downloading books:
--------------------------------

-  Download a **single** book:

.. code:: bash

    bookcut book -b "White Fang" -a "Jack London"

-  Download a **list** of books:

.. code:: bash

    bookcut list "FreeEbooksToDownload.txt"

-  Organise a **folder** full of e-books to folders according to genre:

.. code:: bash

    bookcut organise "full/path/to/folder"

--------------

-  Search **LibGen**, output the results and download e-book:

.. code:: bash

    bookcut search -t 'Homer Odyssey'

-  Search more book repositories with the **--repos** option:

.. code:: bash

    bookcut search -t 'Homer Odyssey' --repos 'libgen,arxiv'

**Available book repositories: Libgen, ArXiv**

--------------

-  Get the **details** of a book by **title and author**, or simply
   **ISBN**.

.. code:: bash

    bookcut details -b 'Homer Iliad'

-  Get a list with *all the books* from an **author**,with an option to
   save to .txt:

.. code:: bash

    bookcut all-books -author 'Stephen King'

--------------

Searching and downloading articles:
-----------------------------------

Now you can use bookcut to search and download **scientific articles**.

-  Search with the Digital Object Identifier:

``bookcut article --doi "10.1126/science.196.4287.293"``

-  Search with the exact title:

::

    bookcut article --title "Ribulose Bisphosphate Carboxylase  A Two-Layered, Square-Shaped Molecule of Symmetry"

--------------

Configuration
-------------

-  Also you can change some basic settings of BookCut. For more check:

.. code:: bash

    bookcut config --help

TO-DO
=====

-  Add Tests
-  Add documentation
-  Add more sources with free e-books
-  Fix organiser so it can use all types of files
-  Add a logger.

Copyrights
==========

Please use the bookcut app to download **only free e-books** that are
legally distributing through *BookCut repositories.* Bookcut
contributors do not have any responsibility for the use of the tool.

Contributing
============

Pull requests are welcome, this is my first project so be kind. For
major changes, please open an issue first to discuss what you would like
to change.

Please make sure to update tests as appropriate.

License
=======

`MIT <https://choosealicense.com/licenses/mit/>`__

.. |Downloads| image:: https://pepy.tech/badge/bookcut
   :target: https://pepy.tech/project/bookcut
.. |pypi| image:: https://img.shields.io/pypi/v/pip.svg


