pyipsw


Namepyipsw JSON
Version 0.0.2 PyPI version JSON
download
home_page
Summaryutility created in order to access ipsw.me data easily using python/cli
upload_time2023-07-12 06:07:48
maintainer
docs_urlNone
author
requires_python>=3.8
licenseMIT License Copyright (c) 2021 Matan Perelman Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords ios ipsw firmware cli
VCS
bugtrack_url
requirements humanfriendly click requests tqdm setuptools
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Python application](https://github.com/matan1008/pyipsw/workflows/Python%20application/badge.svg)](https://github.com/matan1008/pyipsw/actions/workflows/python-app.yml "Python application action")
[![Pypi version](https://img.shields.io/pypi/v/pyipsw.svg)](https://pypi.org/project/pyipsw/ "PyPi package")

- [Description](#description)
- [Installation](#installation)
- [Usage](#usage)
    * [CLI](#cli)

# Description

`pyipsw` is a utility created in order to access ipsw.me data easily using python / cli.

# Installation

Install the last released version using `pip`:

```shell
python3 -m pip install -U pyipsw
```

Or install the latest version from sources:

```shell
git clone git@github.com:matan1008/pyipsw.git
cd pyipsw
python3 -m pip install -U -e .
```

# Usage

## CLI

In order to show data about devices, just run the devices command:

```shell
pyipsw devices
```

If you require more or less data, add `-c` with column name:

```shell
pyipsw devices -c device -c version -c BoardConfig
```

Run `pyipsw devices --help` to see available columns:

```shell
Usage: pyipsw devices [OPTIONS]

  Show data about apple devices.

Options:
  -c, --columns [device|name|version|buildid|url|uploaddate|size|signed|sha1sum|releasedate|platform|md5sum|filename|cpid|bdid|BoardConfig]
                                  Data to show
  -f, --filters TEXT              Python code to act as filter to devices,
                                  e.g. "iPhone11" in device
  --help                          Show this message and exit.
```

You can also add python code to filter the printed data:

```shell
pyipsw devices -f "'iPhone10' in device and '14.4' in version"
```

Which will output:

```
------------------------------------------------------------------------------------
| device     | version | buildid | filename                                        |
------------------------------------------------------------------------------------
| iPhone10,1 | 14.4.2  | 18D70   | iPhone_4.7_P3_14.4.2_18D70_Restore.ipsw         |
| iPhone10,1 | 14.4.1  | 18D61   | iPhone_4.7_P3_14.4.1_18D61_Restore.ipsw         |
| iPhone10,1 | 14.4    | 18D52   | iPhone_4.7_P3_14.4_18D52_Restore.ipsw           |
| iPhone10,2 | 14.4.2  | 18D70   | iPhone_5.5_P3_14.4.2_18D70_Restore.ipsw         |
| iPhone10,2 | 14.4.1  | 18D61   | iPhone_5.5_P3_14.4.1_18D61_Restore.ipsw         |
| iPhone10,2 | 14.4    | 18D52   | iPhone_5.5_P3_14.4_18D52_Restore.ipsw           |
| iPhone10,3 | 14.4.2  | 18D70   | iPhone10,3,iPhone10,6_14.4.2_18D70_Restore.ipsw |
| iPhone10,3 | 14.4.1  | 18D61   | iPhone10,3,iPhone10,6_14.4.1_18D61_Restore.ipsw |
| iPhone10,3 | 14.4    | 18D52   | iPhone10,3,iPhone10,6_14.4_18D52_Restore.ipsw   |
| iPhone10,4 | 14.4.2  | 18D70   | iPhone_4.7_P3_14.4.2_18D70_Restore.ipsw         |
| iPhone10,4 | 14.4.1  | 18D61   | iPhone_4.7_P3_14.4.1_18D61_Restore.ipsw         |
| iPhone10,4 | 14.4    | 18D52   | iPhone_4.7_P3_14.4_18D52_Restore.ipsw           |
| iPhone10,5 | 14.4.2  | 18D70   | iPhone_5.5_P3_14.4.2_18D70_Restore.ipsw         |
| iPhone10,5 | 14.4.1  | 18D61   | iPhone_5.5_P3_14.4.1_18D61_Restore.ipsw         |
| iPhone10,5 | 14.4    | 18D52   | iPhone_5.5_P3_14.4_18D52_Restore.ipsw           |
| iPhone10,6 | 14.4.2  | 18D70   | iPhone10,3,iPhone10,6_14.4.2_18D70_Restore.ipsw |
| iPhone10,6 | 14.4.1  | 18D61   | iPhone10,3,iPhone10,6_14.4.1_18D61_Restore.ipsw |
| iPhone10,6 | 14.4    | 18D52   | iPhone10,3,iPhone10,6_14.4_18D52_Restore.ipsw   |
------------------------------------------------------------------------------------
```

You can also download the firmwares with:

```shell
pyipsw download-devices /tmp/firmwares -f "'iPhone10' in device and '14.4' in version"
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "pyipsw",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "matan1008 <matan1008@gmail.com>",
    "keywords": "ios,ipsw,firmware,cli",
    "author": "",
    "author_email": "matan1008 <matan1008@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/c2/ae/d776bac64092d2d68789b99c53ac16fe243a78f7aaab1e889eb0d70d7372/pyipsw-0.0.2.tar.gz",
    "platform": null,
    "description": "[![Python application](https://github.com/matan1008/pyipsw/workflows/Python%20application/badge.svg)](https://github.com/matan1008/pyipsw/actions/workflows/python-app.yml \"Python application action\")\n[![Pypi version](https://img.shields.io/pypi/v/pyipsw.svg)](https://pypi.org/project/pyipsw/ \"PyPi package\")\n\n- [Description](#description)\n- [Installation](#installation)\n- [Usage](#usage)\n    * [CLI](#cli)\n\n# Description\n\n`pyipsw` is a utility created in order to access ipsw.me data easily using python / cli.\n\n# Installation\n\nInstall the last released version using `pip`:\n\n```shell\npython3 -m pip install -U pyipsw\n```\n\nOr install the latest version from sources:\n\n```shell\ngit clone git@github.com:matan1008/pyipsw.git\ncd pyipsw\npython3 -m pip install -U -e .\n```\n\n# Usage\n\n## CLI\n\nIn order to show data about devices, just run the devices command:\n\n```shell\npyipsw devices\n```\n\nIf you require more or less data, add `-c` with column name:\n\n```shell\npyipsw devices -c device -c version -c BoardConfig\n```\n\nRun `pyipsw devices --help` to see available columns:\n\n```shell\nUsage: pyipsw devices [OPTIONS]\n\n  Show data about apple devices.\n\nOptions:\n  -c, --columns [device|name|version|buildid|url|uploaddate|size|signed|sha1sum|releasedate|platform|md5sum|filename|cpid|bdid|BoardConfig]\n                                  Data to show\n  -f, --filters TEXT              Python code to act as filter to devices,\n                                  e.g. \"iPhone11\" in device\n  --help                          Show this message and exit.\n```\n\nYou can also add python code to filter the printed data:\n\n```shell\npyipsw devices -f \"'iPhone10' in device and '14.4' in version\"\n```\n\nWhich will output:\n\n```\n------------------------------------------------------------------------------------\n| device     | version | buildid | filename                                        |\n------------------------------------------------------------------------------------\n| iPhone10,1 | 14.4.2  | 18D70   | iPhone_4.7_P3_14.4.2_18D70_Restore.ipsw         |\n| iPhone10,1 | 14.4.1  | 18D61   | iPhone_4.7_P3_14.4.1_18D61_Restore.ipsw         |\n| iPhone10,1 | 14.4    | 18D52   | iPhone_4.7_P3_14.4_18D52_Restore.ipsw           |\n| iPhone10,2 | 14.4.2  | 18D70   | iPhone_5.5_P3_14.4.2_18D70_Restore.ipsw         |\n| iPhone10,2 | 14.4.1  | 18D61   | iPhone_5.5_P3_14.4.1_18D61_Restore.ipsw         |\n| iPhone10,2 | 14.4    | 18D52   | iPhone_5.5_P3_14.4_18D52_Restore.ipsw           |\n| iPhone10,3 | 14.4.2  | 18D70   | iPhone10,3,iPhone10,6_14.4.2_18D70_Restore.ipsw |\n| iPhone10,3 | 14.4.1  | 18D61   | iPhone10,3,iPhone10,6_14.4.1_18D61_Restore.ipsw |\n| iPhone10,3 | 14.4    | 18D52   | iPhone10,3,iPhone10,6_14.4_18D52_Restore.ipsw   |\n| iPhone10,4 | 14.4.2  | 18D70   | iPhone_4.7_P3_14.4.2_18D70_Restore.ipsw         |\n| iPhone10,4 | 14.4.1  | 18D61   | iPhone_4.7_P3_14.4.1_18D61_Restore.ipsw         |\n| iPhone10,4 | 14.4    | 18D52   | iPhone_4.7_P3_14.4_18D52_Restore.ipsw           |\n| iPhone10,5 | 14.4.2  | 18D70   | iPhone_5.5_P3_14.4.2_18D70_Restore.ipsw         |\n| iPhone10,5 | 14.4.1  | 18D61   | iPhone_5.5_P3_14.4.1_18D61_Restore.ipsw         |\n| iPhone10,5 | 14.4    | 18D52   | iPhone_5.5_P3_14.4_18D52_Restore.ipsw           |\n| iPhone10,6 | 14.4.2  | 18D70   | iPhone10,3,iPhone10,6_14.4.2_18D70_Restore.ipsw |\n| iPhone10,6 | 14.4.1  | 18D61   | iPhone10,3,iPhone10,6_14.4.1_18D61_Restore.ipsw |\n| iPhone10,6 | 14.4    | 18D52   | iPhone10,3,iPhone10,6_14.4_18D52_Restore.ipsw   |\n------------------------------------------------------------------------------------\n```\n\nYou can also download the firmwares with:\n\n```shell\npyipsw download-devices /tmp/firmwares -f \"'iPhone10' in device and '14.4' in version\"\n```\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2021 Matan Perelman  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "utility created in order to access ipsw.me data easily using python/cli",
    "version": "0.0.2",
    "project_urls": {
        "Bug Reports": "https://github.com/matan1008/pyipsw/issues",
        "Homepage": "https://github.com/matan1008/pyipsw"
    },
    "split_keywords": [
        "ios",
        "ipsw",
        "firmware",
        "cli"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dd6531afd8e9a98436b0dd3a7853164a8b37d56746d12d654290cccb86929b57",
                "md5": "1daec34ff3346bfadfc9a6d1f45faf47",
                "sha256": "3ed01c61cafa5a322d8875c9fb9c25e910402bbbb082751cdd1da1d2a9ffae4a"
            },
            "downloads": -1,
            "filename": "pyipsw-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1daec34ff3346bfadfc9a6d1f45faf47",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 6700,
            "upload_time": "2023-07-12T06:07:46",
            "upload_time_iso_8601": "2023-07-12T06:07:46.615941Z",
            "url": "https://files.pythonhosted.org/packages/dd/65/31afd8e9a98436b0dd3a7853164a8b37d56746d12d654290cccb86929b57/pyipsw-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c2aed776bac64092d2d68789b99c53ac16fe243a78f7aaab1e889eb0d70d7372",
                "md5": "de126f4b7cad1cbb12a2eaf9a6654927",
                "sha256": "000b67df3e3085aa7b88c566f7abe7b968a04ab1f882afdc37aa7c8a1e1c5ce8"
            },
            "downloads": -1,
            "filename": "pyipsw-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "de126f4b7cad1cbb12a2eaf9a6654927",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 5438,
            "upload_time": "2023-07-12T06:07:48",
            "upload_time_iso_8601": "2023-07-12T06:07:48.177568Z",
            "url": "https://files.pythonhosted.org/packages/c2/ae/d776bac64092d2d68789b99c53ac16fe243a78f7aaab1e889eb0d70d7372/pyipsw-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-12 06:07:48",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "matan1008",
    "github_project": "pyipsw",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "humanfriendly",
            "specs": []
        },
        {
            "name": "click",
            "specs": []
        },
        {
            "name": "requests",
            "specs": []
        },
        {
            "name": "tqdm",
            "specs": []
        },
        {
            "name": "setuptools",
            "specs": []
        }
    ],
    "lcname": "pyipsw"
}
        
Elapsed time: 0.15769s