Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/costis94/bookcut
Command Line Interface tool to download, organise and search free ebooks from your terminal in a moment.
https://github.com/costis94/bookcut
command-line-tool ebook epub free-ebooks genre isbn libgen openlibrary organiser python python3 terminal-based
Last synced: about 1 month ago
JSON representation
Command Line Interface tool to download, organise and search free ebooks from your terminal in a moment.
- Host: GitHub
- URL: https://github.com/costis94/bookcut
- Owner: costis94
- License: mit
- Created: 2020-07-18T14:13:17.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-12T18:47:04.000Z (almost 3 years ago)
- Last Synced: 2024-11-02T16:25:59.024Z (about 1 month ago)
- Topics: command-line-tool, ebook, epub, free-ebooks, genre, isbn, libgen, openlibrary, organiser, python, python3, terminal-based
- Language: Python
- Homepage:
- Size: 173 KB
- Stars: 185
- Watchers: 3
- Forks: 11
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- project-awesome - costis94/bookcut - Command Line Interface tool to download, organise and search free ebooks from your terminal in a moment. (Python)
README
[](https://pepy.tech/project/bookcut) 
[](https://github.com/psf/black)
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:**
```bash
pip install bookcut
#or if you have also Python 2
pip3 install bookcut
```
## Usage
### Searching and downloading books:
* Download a **single** book:
```bash
bookcut book -b "White Fang" -a "Jack London"
```
* Download a **list** of books:
```bash
bookcut list "FreeEbooksToDownload.txt"
```
* Organise a **folder** full of e-books to folders according to genre:
```bash
bookcut organise "full/path/to/folder"
```
***
* Search **LibGen**, output the results and download e-book:
```bash
bookcut search -t 'Homer Odyssey'
```
* Search more book repositories with the **--repos** option:
``` 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**.
```bash
bookcut details -b 'Homer Iliad'
```
* Get a list with *all the books* from an **author**,with an option to save to .txt:
```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:
```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/)