From 0e6b88cc999e807262d4aa6ee220ade965842aa2 Mon Sep 17 00:00:00 2001 From: James Sharkey Date: Sun, 24 Dec 2023 11:16:47 +0000 Subject: [PATCH] Update README, description and keywords for PyPI --- README.md | 16 +++------------- pyproject.toml | 6 ++++-- 2 files changed, 7 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 2c7f774..5c658e4 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ itself based on the [iphone-dataprotection](https://code.google.com/p/iphone-dat ## Install -Requires [Python 3.4](https://www.python.org/) or higher. +Requires [Python 3.8](https://www.python.org/) or higher. The code requires a cryptographic library providing the `Crypto` name. Use `pycryptodome` (but note that this clashes with `pycrypto`, if that is already installed). @@ -15,19 +15,9 @@ The backup decryption keys are protected using 10 million rounds of PBKDF2 with To speed up decryption, `fastpbkdf2` is desirable; otherwise the code will fall back to using standard library functions. The fallback is much slower, but does not require the complicated build and install of `fastpbkdf2`. -Ideal dependencies: +Install via `pip`: ```shell script -pip install biplist pycryptodome fastpbkdf2 -``` - -Minimal required dependencies (automatically installed): -```shell script -pip install biplist pycryptodome -``` - -Install directly from GitHub via `pip`: -```shell script -pip install git+https://github.com/jsharkey13/iphone_backup_decrypt +pip install iphone_backup_decrypt # Optionally: pip install fastpbkdf2 ``` diff --git a/pyproject.toml b/pyproject.toml index 8d2510c..64687cb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,10 +1,10 @@ [project] name = "iphone_backup_decrypt" -version = "0.3.0" +version = "0.3.1" authors = [ { name="James Sharkey" }, ] -description = "Decrypt an iOS13+ encrypted local backup." +description = "Decrypt and extract files from an iOS13+ encrypted local backup." readme = "README.md" requires-python = ">=3.8" classifiers = [ @@ -12,6 +12,8 @@ classifiers = [ "Topic :: Security :: Cryptography" ] +keywords = ["iPhone", "backup", "forensics", "iOS", "WhatsApp", "decryption", "iOS backup", "iTunes Backup"] + dependencies = [ "biplist>=1.0.3", "pycryptodome>=3.9.1"