# Screener
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
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](https://www.python.org/about/gettingstarted/) (version 3.10 or newer).
### Installing
Screener is available on [PyPI](https://pypi.org/project/screener/). To install, run:
```bash
pip install screener
```
#### Development installation
To install Screener for development, ensure you have [Poetry](https://python-poetry.org/) clone the repository and run:
```bash
poetry install
```
## 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](http://semver.org/) for versioning.
## Authors
Screener was created by Tom Kuson ([@tjkuson](https://github.com/tjkuson)).
## Licence
Screener is released under the [LGPL version 3](LICENCE).
Raw data
{
"_id": null,
"home_page": "https://github.com/tjkuson/screener/",
"name": "screener",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "ebook,security,privacy,epub,mobi,kindle",
"author": "Tom Kuson",
"author_email": "mail@tjkuson.me",
"download_url": "https://files.pythonhosted.org/packages/fe/88/bc5d6c7bd9a2b457a8cea6708e9754b918eefc2434d6de29e4eb7a2f80df/screener-0.4.1.tar.gz",
"platform": null,
"description": "# Screener\n\nCheck e-book files for security and privacy issues.\n\n## Motivation\n\nE-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.\n\nScreener aims to check e-book files for these issues so that you can read with peace of mind!\n\n## Features\n\n- Check e-book files for JavaScript tags.\n- Check e-book files for images with external sources to prevent tracking.\n- Supports `.epub`, `.mobi`, and `.azw3` files.\n\n## Get started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\n\n### Prerequisites\n\nScreener requires [Python](https://www.python.org/about/gettingstarted/) (version 3.10 or newer).\n\n### Installing\n\nScreener is available on [PyPI](https://pypi.org/project/screener/). To install, run:\n\n```bash\npip install screener\n```\n\n#### Development installation\n\nTo install Screener for development, ensure you have [Poetry](https://python-poetry.org/) clone the repository and run:\n\n```bash\npoetry install\n```\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nAt present, this project is in early development and needs extra security and privacy checks and wider file format support more than anything else.\n\nPlease make sure to update tests as appropriate.\n\n## Versioning\n\nThis project uses [SemVer](http://semver.org/) for versioning.\n\n## Authors\n\nScreener was created by Tom Kuson ([@tjkuson](https://github.com/tjkuson)).\n\n## Licence\n\nScreener is released under the [LGPL version 3](LICENCE).\n",
"bugtrack_url": null,
"license": "LGPL-3.0-only",
"summary": "Check e-book files for security and privacy issues.",
"version": "0.4.1",
"project_urls": {
"Homepage": "https://github.com/tjkuson/screener/",
"Repository": "https://github.com/tjkuson/screener/"
},
"split_keywords": [
"ebook",
"security",
"privacy",
"epub",
"mobi",
"kindle"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0f2b8cf9041176de87c2ffc33ee95a79b4efa8d5cbcefc65a4740f54f2b1ae47",
"md5": "568f37d7d0ff40d760c176b32d88b974",
"sha256": "ce18790874256cc57b5879b6c835613ff0bf0a1561a7d2a1a04c3bb1d221de24"
},
"downloads": -1,
"filename": "screener-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "568f37d7d0ff40d760c176b32d88b974",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 7995,
"upload_time": "2023-06-11T13:17:19",
"upload_time_iso_8601": "2023-06-11T13:17:19.916030Z",
"url": "https://files.pythonhosted.org/packages/0f/2b/8cf9041176de87c2ffc33ee95a79b4efa8d5cbcefc65a4740f54f2b1ae47/screener-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fe88bc5d6c7bd9a2b457a8cea6708e9754b918eefc2434d6de29e4eb7a2f80df",
"md5": "a7735b5df7ddedf2b7442d5f8db0cf95",
"sha256": "f45dd3432007b5605af144a812d0795066120e0090059b86df364ae704570cb4"
},
"downloads": -1,
"filename": "screener-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "a7735b5df7ddedf2b7442d5f8db0cf95",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 6800,
"upload_time": "2023-06-11T13:17:21",
"upload_time_iso_8601": "2023-06-11T13:17:21.703820Z",
"url": "https://files.pythonhosted.org/packages/fe/88/bc5d6c7bd9a2b457a8cea6708e9754b918eefc2434d6de29e4eb7a2f80df/screener-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-11 13:17:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tjkuson",
"github_project": "screener",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "screener"
}
JSON
