Skip to content

Check e-book files for security and privacy issues.

License

Notifications You must be signed in to change notification settings

tjkuson/screener

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Screener

image image

Check e-book files for security and privacy issues.

Motivation

E-books are great, but the common file formats have security and privacy issues. Most use web browser technologies like HTML, CSS, and JavaScript. Therefore, e-books are vulnerable to security and privacy issues that already exist on the web.

Screener aims to check e-book files for these issues so that you can read with peace of mind!

Features

  • Check e-book files for JavaScript tags.
  • Check e-book files for images with external sources to prevent tracking.
  • Supports .epub, .mobi, and .azw3 files.

Get started

Prerequisites

Screener requires Python.

Installing

Screener is available on PyPI. To install, run:

pip install screener

Development installation

To install Screener for development, ensure you have Poetry clone the repository and run:

poetry install

Usage

To check a file, try:

screener path/to/file.epub

For help:

screener --help

Contributing

Pull requests are welcome and appreciated. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.

If you have found a bug or have a feature request, please open an issue.

Versioning

This project uses SemVer for versioning.

Authors

Screener was created by Tom Kuson (@tjkuson).

Licence

Screener is released under the LGPL version 3.