gutenberg-cleaner

cleans gutenberg dataset books


License
MIT
Install
pip install gutenberg-cleaner==0.1.6

Documentation

gutenberg-cleaner

a python package for cleaning Gutenberg books and dataset.

Prerequisites

nltk package

Installing

[sudo] pip install gutenberg-cleaner

How to use it?

it has two methods called "simple_cleaner" and "super_cleaner".

simple_claner:

Just removes lines that are part of the Project Gutenberg header or footer. Doesnt go deeply in the text to remove other things like titles or footnotes or etc...

simple_cleaner(book: str) -> str

super_cleaner:

Super clean the book (titles, footnotes, images, book information, etc.). may delete some good lines too.

super_cleaner(book: str, min_token: int = 5, max_token: int = 600) -> str

min_token: The minimum tokens of a paragraph that is not "dialog" or "quote", -1 means don't tokenize the txt (so it will be faster, but less efficient cleaning). max_token: The maximum tokens of a paragraph.

it will mark deleted paragraphs with: [deleted]

Author

  • Peyman Mohseni kiasari

License

This project is licensed under the MIT License - see the LICENSE.md file for details