Name | pe-analyzer JSON |
Version |
0.1.2
JSON |
| download |
home_page | |
Summary | A Python module to analyze Portable Executable (PE) files on Windows systems. It parses and extracts various details about the file header, optional header, sections, imports, and exports. The module provides an easy-to-use class, PEAnalyzer, which returns analysis data in JSON format and supports pretty-printing of the information when used with the print() function. |
upload_time | 2023-04-13 16:37:50 |
maintainer | |
docs_url | None |
author | DJ Stomp |
requires_python | >=3.10,<4.0 |
license | MIT |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# PEAnalyzer
A Python module to analyze Portable Executable (PE) files on Windows systems. It parses and extracts various details about the file header, optional header, sections, imports, and exports. The module provides an easy-to-use class, `PEAnalyzer`, which returns analysis data in JSON format and supports pretty-printing of the information when used with the `print()` function.
| Info | Package | CI/CD | Support |
| :------------: | :---------------------------------------------------------: | :----------------------------: | :-------------------------: |
| [](https://pypi.org/project/pe-analyzer/) | [](https://pypi.org/project/pe-analyzer/) | [](https://github.com/DJStompZone/PE-Analyzer/actions/workflows/codeql.yml) | [](https://discord.io/stomp) |
| [](https://github.com/DJStompZone/PE-Analyzer/blob/main/LICENSE) | [](https://pypi.org/project/pe-analyzer/) | [](https://github.com/DJStompZone/PE-Analyzer/actions/workflows/pytest.yml) | [](https://github.com/DJStompZone/PE-Analyzer/issues/new/choose)
## Installation
To use PEAnalyzer, first, install the `pefile` library by running:
```
pip install pefile
```
Then, download or clone this repository to your project directory.
## Usage
To use the `PEAnalyzer` class, import it from the module and create an instance with the path to the PE file you want to analyze:
```python
from pe_analyzer import PEAnalyzer
file_path = "path/to/your/file.exe"
analyzer = PEAnalyzer(file_path)
```
To print the analysis data in a human-readable format, use the `print()` function:
```python
print(analyzer)
```
To get the analysis data as a JSON object, call the `analyze()` method:
```python
analysis_data = analyzer.analyze()
print(analysis_data)
```
## Support
#### You can create a new issue here:
[](https://github.com/DJStompZone/PE-Analyzer/issues/new/choose)
#### Or join my Discord server here:
[](https://discord.io/stomp)
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
Raw data
{
"_id": null,
"home_page": "",
"name": "pe-analyzer",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "DJ Stomp",
"author_email": "85457381+DJStompZone@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/df/fb/5dfdb0095863fc4d6565c6538b7e7f0ba52dbdc633a25f008bbee142e23b/pe_analyzer-0.1.2.tar.gz",
"platform": null,
"description": "# PEAnalyzer\n\nA Python module to analyze Portable Executable (PE) files on Windows systems. It parses and extracts various details about the file header, optional header, sections, imports, and exports. The module provides an easy-to-use class, `PEAnalyzer`, which returns analysis data in JSON format and supports pretty-printing of the information when used with the `print()` function.\n\n\n| Info | Package | CI/CD | Support |\n| :------------: | :---------------------------------------------------------: | :----------------------------: | :-------------------------: |\n| [](https://pypi.org/project/pe-analyzer/) | [](https://pypi.org/project/pe-analyzer/) | [](https://github.com/DJStompZone/PE-Analyzer/actions/workflows/codeql.yml) | [](https://discord.io/stomp) |\n| [](https://github.com/DJStompZone/PE-Analyzer/blob/main/LICENSE) | [](https://pypi.org/project/pe-analyzer/) | [](https://github.com/DJStompZone/PE-Analyzer/actions/workflows/pytest.yml) | [](https://github.com/DJStompZone/PE-Analyzer/issues/new/choose)\n\n\n## Installation\n\nTo use PEAnalyzer, first, install the `pefile` library by running:\n\n```\npip install pefile\n```\n\nThen, download or clone this repository to your project directory.\n\n## Usage\n\nTo use the `PEAnalyzer` class, import it from the module and create an instance with the path to the PE file you want to analyze:\n\n```python\nfrom pe_analyzer import PEAnalyzer\n\nfile_path = \"path/to/your/file.exe\"\nanalyzer = PEAnalyzer(file_path)\n```\n\nTo print the analysis data in a human-readable format, use the `print()` function:\n\n```python\nprint(analyzer)\n```\n\nTo get the analysis data as a JSON object, call the `analyze()` method:\n\n```python\nanalysis_data = analyzer.analyze()\nprint(analysis_data)\n```\n\n## Support\n\n#### You can create a new issue here: \n\n[](https://github.com/DJStompZone/PE-Analyzer/issues/new/choose)\n\n#### Or join my Discord server here:\n\n[](https://discord.io/stomp)\n\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python module to analyze Portable Executable (PE) files on Windows systems. It parses and extracts various details about the file header, optional header, sections, imports, and exports. The module provides an easy-to-use class, PEAnalyzer, which returns analysis data in JSON format and supports pretty-printing of the information when used with the print() function.",
"version": "0.1.2",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "07781d207b7c8badfb01fde880a9c132825cc5180a618e20ea5307a1512aa0cc",
"md5": "0620688fb06887cabf02ae914da496d9",
"sha256": "924ae34515b250743aced7b53dff97caa68f8b2d2faa7361b5ac2d4266f66ed7"
},
"downloads": -1,
"filename": "pe_analyzer-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0620688fb06887cabf02ae914da496d9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 141197,
"upload_time": "2023-04-13T16:37:42",
"upload_time_iso_8601": "2023-04-13T16:37:42.438477Z",
"url": "https://files.pythonhosted.org/packages/07/78/1d207b7c8badfb01fde880a9c132825cc5180a618e20ea5307a1512aa0cc/pe_analyzer-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dffb5dfdb0095863fc4d6565c6538b7e7f0ba52dbdc633a25f008bbee142e23b",
"md5": "df0d00ffffb7ff8fb584e1e3681e474c",
"sha256": "633cd1e43e2e38106fbaece95df402854eaf17ea63e2d57d2e3f6cc26920f370"
},
"downloads": -1,
"filename": "pe_analyzer-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "df0d00ffffb7ff8fb584e1e3681e474c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 140814,
"upload_time": "2023-04-13T16:37:50",
"upload_time_iso_8601": "2023-04-13T16:37:50.565613Z",
"url": "https://files.pythonhosted.org/packages/df/fb/5dfdb0095863fc4d6565c6538b7e7f0ba52dbdc633a25f008bbee142e23b/pe_analyzer-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-13 16:37:50",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "pe-analyzer"
}