# PBOkit
Fully-typed Arma 3 PBO extractor library for Python 3.10 and up.
# Usage
## Load PBOkit
```python
import pbokit
```
## Read the contents of a PBO file
```python
pbo = pbokit.PBO.from_file("pbofile.pbo")
```
## Read a PBO file from bytes
```python
pbo = pbokit.PBO.from_bytes(b"bytes_go_here")
```
## Check if a file exists in the PBO
```python
pbo = pbokit.PBO.from_file("pbofile.pbo")
pbo.has_file("description.ext")
```
## Read the contents of a file in the PBO
### Binary Files
```python
pbo = pbokit.PBO.from_file("pbofile.pbo")
pbo["loadscreen.paa"].as_bytes()
```
### Text Files
```python
pbo = pbokit.PBO.from_file("pbofile.pbo")
pbo["description.ext"].as_str()
```
## Read header values from the PBO
```python
pbo = pbokit.PBO.from_file("pbofile.pbo")
pbo.headers["prefix"]
```
Raw data
{
"_id": null,
"home_page": "",
"name": "pbokit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "",
"author": "Superxpdude",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/06/14/92c0d67272aba1f65d9464857b81c7ff2ce5fd5a2bc8a6306b16996b7332/pbokit-0.2.0.tar.gz",
"platform": null,
"description": "# PBOkit\r\nFully-typed Arma 3 PBO extractor library for Python 3.10 and up.\r\n# Usage\r\n## Load PBOkit\r\n```python\r\nimport pbokit\r\n```\r\n## Read the contents of a PBO file\r\n```python\r\npbo = pbokit.PBO.from_file(\"pbofile.pbo\")\r\n```\r\n## Read a PBO file from bytes\r\n```python\r\npbo = pbokit.PBO.from_bytes(b\"bytes_go_here\")\r\n```\r\n## Check if a file exists in the PBO\r\n```python\r\npbo = pbokit.PBO.from_file(\"pbofile.pbo\")\r\npbo.has_file(\"description.ext\")\r\n```\r\n## Read the contents of a file in the PBO\r\n### Binary Files\r\n```python\r\npbo = pbokit.PBO.from_file(\"pbofile.pbo\")\r\npbo[\"loadscreen.paa\"].as_bytes()\r\n```\r\n### Text Files\r\n```python\r\npbo = pbokit.PBO.from_file(\"pbofile.pbo\")\r\npbo[\"description.ext\"].as_str()\r\n```\r\n## Read header values from the PBO\r\n```python\r\npbo = pbokit.PBO.from_file(\"pbofile.pbo\")\r\npbo.headers[\"prefix\"]\r\n```\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Fully-typed Arma 3 PBO extractor library",
"version": "0.2.0",
"project_urls": {
"Repository": "https://github.com/Superxpdude/pbokit"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "35017361c356f8d216b5c88b707d3c7626d794165910a8002ba4a748e89e8aa3",
"md5": "ba5a79e0b2303b1952d689db6ecea20b",
"sha256": "04f94ee9b74aecf11720a15614e217d1bc68be3cc46ee3144aaf098cb51e1169"
},
"downloads": -1,
"filename": "pbokit-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ba5a79e0b2303b1952d689db6ecea20b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 3527,
"upload_time": "2023-07-12T02:23:43",
"upload_time_iso_8601": "2023-07-12T02:23:43.884147Z",
"url": "https://files.pythonhosted.org/packages/35/01/7361c356f8d216b5c88b707d3c7626d794165910a8002ba4a748e89e8aa3/pbokit-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "061492c0d67272aba1f65d9464857b81c7ff2ce5fd5a2bc8a6306b16996b7332",
"md5": "51c32627e01ddfc42e521b41e1a9b33b",
"sha256": "536dd0526df5a1e307be203c1d1b036e3d958e3d56ded34e33ab04b0253dd315"
},
"downloads": -1,
"filename": "pbokit-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "51c32627e01ddfc42e521b41e1a9b33b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 4210,
"upload_time": "2023-07-12T02:23:45",
"upload_time_iso_8601": "2023-07-12T02:23:45.492228Z",
"url": "https://files.pythonhosted.org/packages/06/14/92c0d67272aba1f65d9464857b81c7ff2ce5fd5a2bc8a6306b16996b7332/pbokit-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-12 02:23:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Superxpdude",
"github_project": "pbokit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "build",
"specs": [
[
">=",
"0.10.0"
]
]
},
{
"name": "pytest",
"specs": [
[
">=",
"7.3.2"
]
]
},
{
"name": "pytest-cov",
"specs": [
[
">=",
"4.1.0"
]
]
},
{
"name": "twine",
"specs": [
[
">=",
"4.0.2"
]
]
},
{
"name": "yapf",
"specs": [
[
">=",
"0.40.0"
]
]
}
],
"lcname": "pbokit"
}
JSON
