screener 0.2.2

Check e-book files for security and privacy issues.

Screener

Check e-book files for security and privacy issues.

Screener is currently in early development. Please consider contributing if you have the time and know-how!

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

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Screener requires Python (version 3.10 is recommended), pip, and Poetry to be installed.

Installing

Copy the files in this repository and navigate to the repository directory. You can run the project with poetry run.

poetry run python -m screener

You can also run tests.

poetry run pytest

With coverage metrics:

poetry run coverage run -m pytest

Type-checking:

poetry run mypy screener/

This is the recommended way to install Screener for development and testing.

Alternative installation

If you would rather not use poetry run, you can use poetry export to create a requirements.txt file and install the packages directly using pip.

poetry export -f requirements.txt --output requirements.txt
pip install -r requirements.txt

You can then use Python as normal.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

At present, this project is in early development and needs extra security and privacy checks and wider file format support more than anything else.

Please make sure to update tests as appropriate.

Versioning

This project uses SemVer for versioning.

Authors

Screener was created by Tom Kuson (@tjkuson).

Licence

Screener is released under the LGPL version 3.