| Name | hwp-extract JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Simple object extractor for HWP files. |
| upload_time | 2024-11-27 09:33:48 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Modified BSD License ==================== _Copyright © `2024`, `Volexity, Inc`_ _All rights reserved._ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the `Volexity, Inc` nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL `Volexity, Inc` BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
extractor
hwp
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# HWP Extract
This is a Python utility for extracting objects and metadata from `.hwp` files. This script supports extraction of objects from password
protected HWP files (assuming a password is provided).
## Installation
To install HWP Extract, you can use something like this:
`python -m pip install hwp-extract`
## Usage as a library
For examples of how to use HWP Extract as a library, review the code in `src/hwpextract/cli.py`
## CLI usage
Following successful installation of HWP Extract a new CLI utility will be available, for usage see:
`hwp-extract --help`
### Extract embedded files
`hwp-extract /path/to/file.hwp --extract-files`
### Display metadata
`hwp-extract /path/to/file.hwp --extract-meta`
### Extract embedded files from a password protected HWP file with password 1234
`hwp-extract /path/to/file.hwp --extract-files --password 1234`
## Disclaimer
There's another great library for working with .hwp files which is published [here](https://github.com/mete0r/pyhwp). The primary reasons to use this library over pyhwp are:
* Simpler CLI interaction
* Support for password protected HWP files.
If you're looking for a function in this library that doesn't exist, it may well exist in PyHwp.
Raw data
{
"_id": null,
"home_page": null,
"name": "hwp-extract",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "extractor, hwp",
"author": null,
"author_email": "Threat Intel <threatintel@volexity.com>",
"download_url": "https://files.pythonhosted.org/packages/e5/f8/0453d5598b846cfb00e13c4e853eb206171a6efeb8c50af46ffdc90c7273/hwp_extract-0.1.0.tar.gz",
"platform": null,
"description": "# HWP Extract\n\nThis is a Python utility for extracting objects and metadata from `.hwp` files. This script supports extraction of objects from password\nprotected HWP files (assuming a password is provided).\n\n## Installation\n\nTo install HWP Extract, you can use something like this:\n\n`python -m pip install hwp-extract`\n\n## Usage as a library\n\nFor examples of how to use HWP Extract as a library, review the code in `src/hwpextract/cli.py`\n\n## CLI usage\n\nFollowing successful installation of HWP Extract a new CLI utility will be available, for usage see:\n\n`hwp-extract --help`\n\n### Extract embedded files\n\n`hwp-extract /path/to/file.hwp --extract-files`\n\n### Display metadata\n\n`hwp-extract /path/to/file.hwp --extract-meta`\n\n### Extract embedded files from a password protected HWP file with password 1234\n\n`hwp-extract /path/to/file.hwp --extract-files --password 1234`\n\n## Disclaimer\n\nThere's another great library for working with .hwp files which is published [here](https://github.com/mete0r/pyhwp). The primary reasons to use this library over pyhwp are:\n\n* Simpler CLI interaction\n* Support for password protected HWP files.\n\nIf you're looking for a function in this library that doesn't exist, it may well exist in PyHwp.\n",
"bugtrack_url": null,
"license": "Modified BSD License ==================== _Copyright \u00a9 `2024`, `Volexity, Inc`_ _All rights reserved._ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the `Volexity, Inc` nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \u201cAS IS\u201d AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL `Volexity, Inc` BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Simple object extractor for HWP files.",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://github.com/volexity/hwp-extract/blob/master/README.md",
"Issues": "https://github.com/volexity/hwp-extract/issues",
"Source": "https://github.com/volexity/hwp-extract"
},
"split_keywords": [
"extractor",
" hwp"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3a4559dcb3de9b14752b5a5e289175eae198d1154a4d0f052b1acddb70c53284",
"md5": "a6a3a20715067f88e65bd0c11090edaa",
"sha256": "20513f8d897c9472e504c73dbbd769baaa63afa4bbf8fc3f24353f04f201a8b8"
},
"downloads": -1,
"filename": "hwp_extract-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a6a3a20715067f88e65bd0c11090edaa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 10168,
"upload_time": "2024-11-27T09:33:46",
"upload_time_iso_8601": "2024-11-27T09:33:46.920855Z",
"url": "https://files.pythonhosted.org/packages/3a/45/59dcb3de9b14752b5a5e289175eae198d1154a4d0f052b1acddb70c53284/hwp_extract-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e5f80453d5598b846cfb00e13c4e853eb206171a6efeb8c50af46ffdc90c7273",
"md5": "8f0f121a407d6af4c13285585c5d1cdc",
"sha256": "b8a8cde3777fb70cd78c1e611e51292567900e0e0d39f1b2bb95a3f9f45b508c"
},
"downloads": -1,
"filename": "hwp_extract-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "8f0f121a407d6af4c13285585c5d1cdc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 728904,
"upload_time": "2024-11-27T09:33:48",
"upload_time_iso_8601": "2024-11-27T09:33:48.960326Z",
"url": "https://files.pythonhosted.org/packages/e5/f8/0453d5598b846cfb00e13c4e853eb206171a6efeb8c50af46ffdc90c7273/hwp_extract-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-27 09:33:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "volexity",
"github_project": "hwp-extract",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hwp-extract"
}
