python-msi


Namepython-msi JSON
Version 0.0.0a3 PyPI version JSON
download
home_pageNone
SummaryA pure Python library for reading and manipulating Windows Installer (MSI) files. Based on the rust msi crate and msitools utilities
upload_time2025-10-24 20:45:49
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT License
keywords pe installer ole msi
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # pymsi

[![PyPI](https://img.shields.io/pypi/v/python-msi)](https://pypi.org/project/python-msi/)
[![MIT License](https://img.shields.io/pypi/l/python-msi.svg)](https://github.com/nightlark/pymsi/blob/main/LICENSE)
[![Python Versions](https://img.shields.io/pypi/pyversions/python-msi.svg)](https://pypi.org/project/python-msi/)
[![CI](https://github.com/nightlark/pymsi/actions/workflows/ci.yml/badge.svg)](https://github.com/nightlark/pymsi/actions)
[![Documentation Status](https://readthedocs.org/projects/pymsi/badge/?version=latest)](https://pymsi.readthedocs.io/en/latest/?badge=latest)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/nightlark/pymsi/main.svg)](https://results.pre-commit.ci/latest/github/nightlark/pymsi/main)

A pure Python library for reading and manipulating Windows Installer (MSI) files. Based on the rust msi crate and msitools utilities.

## Getting Started

For a demo of what pymsi can do, check out the [online MSI viewer and file extractor](https://pymsi.readthedocs.io/en/latest/msi_viewer.html) on our ReadTheDocs site. It's like lessmsi, but runs fully client-side in your browser.

For more in-depth documentation on pymsi usage and the API, see the [documentation](https://pymsi.readthedocs.io/en/latest/) (very early WIP).

### Installation

pymsi is available on PyPI (PEP 541 request for pymsi name is being processed):

```sh
pip install python-msi
```

It is recommended to either install it in a virtual environment, or use a tool such as pipx or uv to avoid potential conflicts with other Python modules on the same system.

### Usage

To use pymsi as a library that gets called from other code:

```python
import pymsi
```

To use pymsi as a command line tool:

```bash
pymsi <command> [path_to_msi_file] [output_folder]
```

Use the help command to see a list of supported commands:

```bash
Available commands:
  tables - List all tables in the MSI file
  dump - Dump the contents of the MSI file
  test - Check if the file is a valid MSI file
  extract - Extract files from the MSI file
  help - Show this help message
```

## Getting Involved

For questions or support, please create a new discussion on [GitHub Discussions](https://github.com/nightlark/pymsi/discussions/categories/q-a),
or [open an issue](https://github.com/nightlark/pymsi/issues/new/choose) for bug reports and feature requests.

## Contributing

Contributions are welcome. Bug fixes or minor changes are preferred via a
pull request to the [pymsi GitHub repository](https://github.com/nightlark/pymsi).
For more information on contributing see the [CONTRIBUTING](./CONTRIBUTING.md) file.

## License

pymsi is released under the MIT license. See the [LICENSE](./LICENSE)
and [NOTICE](./NOTICE) files for details. All new contributions must be made
under this license.

SPDX-License-Identifier: MIT

LLNL-CODE-862419

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "python-msi",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Asriel Camora <asriel@camora.dev>, Ryan Mast <mast.ryan@gmail.com>",
    "keywords": "pe, installer, ole, msi",
    "author": null,
    "author_email": "Asriel Camora <asriel@camora.dev>, Ryan Mast <mast.ryan@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/cc/95/4cf226abdbec50994d6e6395ecba316de7743fb7c9aa489c6ff7fd95474c/python_msi-0.0.0a3.tar.gz",
    "platform": null,
    "description": "# pymsi\n\n[![PyPI](https://img.shields.io/pypi/v/python-msi)](https://pypi.org/project/python-msi/)\n[![MIT License](https://img.shields.io/pypi/l/python-msi.svg)](https://github.com/nightlark/pymsi/blob/main/LICENSE)\n[![Python Versions](https://img.shields.io/pypi/pyversions/python-msi.svg)](https://pypi.org/project/python-msi/)\n[![CI](https://github.com/nightlark/pymsi/actions/workflows/ci.yml/badge.svg)](https://github.com/nightlark/pymsi/actions)\n[![Documentation Status](https://readthedocs.org/projects/pymsi/badge/?version=latest)](https://pymsi.readthedocs.io/en/latest/?badge=latest)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/nightlark/pymsi/main.svg)](https://results.pre-commit.ci/latest/github/nightlark/pymsi/main)\n\nA pure Python library for reading and manipulating Windows Installer (MSI) files. Based on the rust msi crate and msitools utilities.\n\n## Getting Started\n\nFor a demo of what pymsi can do, check out the [online MSI viewer and file extractor](https://pymsi.readthedocs.io/en/latest/msi_viewer.html) on our ReadTheDocs site. It's like lessmsi, but runs fully client-side in your browser.\n\nFor more in-depth documentation on pymsi usage and the API, see the [documentation](https://pymsi.readthedocs.io/en/latest/) (very early WIP).\n\n### Installation\n\npymsi is available on PyPI (PEP 541 request for pymsi name is being processed):\n\n```sh\npip install python-msi\n```\n\nIt is recommended to either install it in a virtual environment, or use a tool such as pipx or uv to avoid potential conflicts with other Python modules on the same system.\n\n### Usage\n\nTo use pymsi as a library that gets called from other code:\n\n```python\nimport pymsi\n```\n\nTo use pymsi as a command line tool:\n\n```bash\npymsi <command> [path_to_msi_file] [output_folder]\n```\n\nUse the help command to see a list of supported commands:\n\n```bash\nAvailable commands:\n  tables - List all tables in the MSI file\n  dump - Dump the contents of the MSI file\n  test - Check if the file is a valid MSI file\n  extract - Extract files from the MSI file\n  help - Show this help message\n```\n\n## Getting Involved\n\nFor questions or support, please create a new discussion on [GitHub Discussions](https://github.com/nightlark/pymsi/discussions/categories/q-a),\nor [open an issue](https://github.com/nightlark/pymsi/issues/new/choose) for bug reports and feature requests.\n\n## Contributing\n\nContributions are welcome. Bug fixes or minor changes are preferred via a\npull request to the [pymsi GitHub repository](https://github.com/nightlark/pymsi).\nFor more information on contributing see the [CONTRIBUTING](./CONTRIBUTING.md) file.\n\n## License\n\npymsi is released under the MIT license. See the [LICENSE](./LICENSE)\nand [NOTICE](./NOTICE) files for details. All new contributions must be made\nunder this license.\n\nSPDX-License-Identifier: MIT\n\nLLNL-CODE-862419\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "A pure Python library for reading and manipulating Windows Installer (MSI) files. Based on the rust msi crate and msitools utilities",
    "version": "0.0.0a3",
    "project_urls": {
        "Discussions": "https://github.com/nightlark/pymsi/discussions",
        "Documentation": "https://pymsi.readthedocs.io/en/latest/",
        "Homepage": "https://github.com/nightlark/pymsi",
        "Issue Tracker": "https://github.com/nightlark/pymsi/issues",
        "Source Code": "https://github.com/nightlark/pymsi"
    },
    "split_keywords": [
        "pe",
        " installer",
        " ole",
        " msi"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "604011a3254e448c7dabd183b1a8b3442e79c173932438552e2323870beadfff",
                "md5": "16e6af1b1e6452abd81eac12ddd112ae",
                "sha256": "8f2e81e6659caa02a7c0858105c360c1cb7ca0a7e38e1be09feb836b49d22fe9"
            },
            "downloads": -1,
            "filename": "python_msi-0.0.0a3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "16e6af1b1e6452abd81eac12ddd112ae",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 47860,
            "upload_time": "2025-10-24T20:45:47",
            "upload_time_iso_8601": "2025-10-24T20:45:47.662796Z",
            "url": "https://files.pythonhosted.org/packages/60/40/11a3254e448c7dabd183b1a8b3442e79c173932438552e2323870beadfff/python_msi-0.0.0a3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "cc954cf226abdbec50994d6e6395ecba316de7743fb7c9aa489c6ff7fd95474c",
                "md5": "38b83444ca83260247740139f5d922af",
                "sha256": "cadb76a4f578b085aaea85e405ed921d35a4fbf1a2da7d87edde333ac49b0b5d"
            },
            "downloads": -1,
            "filename": "python_msi-0.0.0a3.tar.gz",
            "has_sig": false,
            "md5_digest": "38b83444ca83260247740139f5d922af",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 63914,
            "upload_time": "2025-10-24T20:45:49",
            "upload_time_iso_8601": "2025-10-24T20:45:49.140868Z",
            "url": "https://files.pythonhosted.org/packages/cc/95/4cf226abdbec50994d6e6395ecba316de7743fb7c9aa489c6ff7fd95474c/python_msi-0.0.0a3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-24 20:45:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nightlark",
    "github_project": "pymsi",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "python-msi"
}
        
Elapsed time: 2.02585s