

[](https://virustotal.github.io/yara-x/docs/api/python)
[](https://pepy.tech/project/yara-x)
[](https://pepy.tech/project/yara-x)

The official Python library for [YARA-X](https://virustotal.github.io/yara-x).
Supports Python 3.9+ in Linux, MacOS and Windows.
```python
import yara_x
rules = yara_x.compile('''
rule test {
strings:
$a = "foobar"
condition:
$a
}''')
results = rules.scan(b"foobar")
assert results.matching_rules[0].identifier == "test"
assert results.matching_rules[0].patterns[0].identifier == "$a"
assert results.matching_rules[0].patterns[0].matches[0].offset == 0
assert results.matching_rules[0].patterns[0].matches[0].length == 6
```
For more information about how to use this library, please check
the [documentation](https://virustotal.github.io/yara-x/docs/api/python).
Raw data
{
"_id": null,
"home_page": "https://virustotal.github.io/yara-x",
"name": "yara-x",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "pattern-matching, cybersecurity, forensics, malware, yara",
"author": null,
"author_email": null,
"download_url": null,
"platform": null,
"description": "\n\n[](https://virustotal.github.io/yara-x/docs/api/python)\n[](https://pepy.tech/project/yara-x)\n[](https://pepy.tech/project/yara-x)\n\n\nThe official Python library for [YARA-X](https://virustotal.github.io/yara-x).\nSupports Python 3.9+ in Linux, MacOS and Windows.\n\n```python\nimport yara_x\n\nrules = yara_x.compile('''\n rule test { \n strings: \n $a = \"foobar\" \n condition: \n $a\n }''')\n\nresults = rules.scan(b\"foobar\")\n\nassert results.matching_rules[0].identifier == \"test\"\nassert results.matching_rules[0].patterns[0].identifier == \"$a\"\nassert results.matching_rules[0].patterns[0].matches[0].offset == 0\nassert results.matching_rules[0].patterns[0].matches[0].length == 6\n```\n\nFor more information about how to use this library, please check\nthe [documentation](https://virustotal.github.io/yara-x/docs/api/python).\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Python bindings for YARA-X",
"version": "1.4.0",
"project_urls": {
"Homepage": "https://virustotal.github.io/yara-x",
"repository": "https://github.com/VirusTotal/yara-x.git"
},
"split_keywords": [
"pattern-matching",
" cybersecurity",
" forensics",
" malware",
" yara"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2d0a6aadd237bfe7acc1cab78694862bfaeff9141ce3c3aa425cedf931853c4b",
"md5": "219e85ee3b1ed6bf57d98e12ceb3d42d",
"sha256": "e3fa22678db8cba799d85744ffbceee361d53f032d363420dd9c9ead58730ca2"
},
"downloads": -1,
"filename": "yara_x-1.4.0-cp38-abi3-macosx_10_12_x86_64.whl",
"has_sig": false,
"md5_digest": "219e85ee3b1ed6bf57d98e12ceb3d42d",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.9",
"size": 8232267,
"upload_time": "2025-07-10T07:19:04",
"upload_time_iso_8601": "2025-07-10T07:19:04.446873Z",
"url": "https://files.pythonhosted.org/packages/2d/0a/6aadd237bfe7acc1cab78694862bfaeff9141ce3c3aa425cedf931853c4b/yara_x-1.4.0-cp38-abi3-macosx_10_12_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "68bf0c07fac9cbf3af5029e6f8d50c77085289ef2434ad972649a3b9c91c760c",
"md5": "e3891ca7b0e3ceaae782cbb6d57df6c9",
"sha256": "f66fcd9e981929be6c262a0eb1930fe46e643529f48910699a2aa7975ad3334f"
},
"downloads": -1,
"filename": "yara_x-1.4.0-cp38-abi3-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "e3891ca7b0e3ceaae782cbb6d57df6c9",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.9",
"size": 7731019,
"upload_time": "2025-07-10T07:19:06",
"upload_time_iso_8601": "2025-07-10T07:19:06.425424Z",
"url": "https://files.pythonhosted.org/packages/68/bf/0c07fac9cbf3af5029e6f8d50c77085289ef2434ad972649a3b9c91c760c/yara_x-1.4.0-cp38-abi3-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "dda2e544b568aa790dba30bdafe8625845e195143a3516b8bcdc2c37cbfd7e4a",
"md5": "550152b000bd158c9d7b33c8258a3766",
"sha256": "5e7529a330f81adf261384712f6d226cb2304c2935f7c05bc3c5b9a75f21421e"
},
"downloads": -1,
"filename": "yara_x-1.4.0-cp38-abi3-manylinux_2_28_aarch64.whl",
"has_sig": false,
"md5_digest": "550152b000bd158c9d7b33c8258a3766",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.9",
"size": 8525697,
"upload_time": "2025-07-10T07:19:08",
"upload_time_iso_8601": "2025-07-10T07:19:08.202769Z",
"url": "https://files.pythonhosted.org/packages/dd/a2/e544b568aa790dba30bdafe8625845e195143a3516b8bcdc2c37cbfd7e4a/yara_x-1.4.0-cp38-abi3-manylinux_2_28_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "24e7bc06b90191ae4f3fe2afa8d2960a58b4471e046344b1a1f10c9c229ec919",
"md5": "974aab148c33ace57c5391f39d13891f",
"sha256": "b2dc9048534fb2d4e13e4753a0eba91656efc0374380cd142f2e94873eec63d9"
},
"downloads": -1,
"filename": "yara_x-1.4.0-cp38-abi3-manylinux_2_28_x86_64.whl",
"has_sig": false,
"md5_digest": "974aab148c33ace57c5391f39d13891f",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.9",
"size": 9080815,
"upload_time": "2025-07-10T07:19:10",
"upload_time_iso_8601": "2025-07-10T07:19:10.755216Z",
"url": "https://files.pythonhosted.org/packages/24/e7/bc06b90191ae4f3fe2afa8d2960a58b4471e046344b1a1f10c9c229ec919/yara_x-1.4.0-cp38-abi3-manylinux_2_28_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "101fccf7adcb83253d2d05a91f15541fd5bcc34ff7f3ef396b18e0ee9580e8e5",
"md5": "ae9b5460ff7f0a19a3499d6d2c2bff4b",
"sha256": "c7eda00e054bcfbc310304ddd048cb06dc1070c5513b04f022909935db346f0f"
},
"downloads": -1,
"filename": "yara_x-1.4.0-cp38-abi3-win_amd64.whl",
"has_sig": false,
"md5_digest": "ae9b5460ff7f0a19a3499d6d2c2bff4b",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.9",
"size": 7040940,
"upload_time": "2025-07-10T07:19:13",
"upload_time_iso_8601": "2025-07-10T07:19:13.413377Z",
"url": "https://files.pythonhosted.org/packages/10/1f/ccf7adcb83253d2d05a91f15541fd5bcc34ff7f3ef396b18e0ee9580e8e5/yara_x-1.4.0-cp38-abi3-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1b0ddcfdad38280494d6c655f346c0e1b075f18d6e7017c8b516bc1ddc141dd7",
"md5": "b264b73f2521eef9e169e32b09ffa708",
"sha256": "637a9cc2fe775331652746436fb2c9a7a177a0608c34b06c1211d73ac2f17499"
},
"downloads": -1,
"filename": "yara_x-1.4.0-pp310-pypy310_pp73-macosx_10_15_x86_64.whl",
"has_sig": false,
"md5_digest": "b264b73f2521eef9e169e32b09ffa708",
"packagetype": "bdist_wheel",
"python_version": "pp310",
"requires_python": ">=3.9",
"size": 8231693,
"upload_time": "2025-07-10T07:19:15",
"upload_time_iso_8601": "2025-07-10T07:19:15.186325Z",
"url": "https://files.pythonhosted.org/packages/1b/0d/dcfdad38280494d6c655f346c0e1b075f18d6e7017c8b516bc1ddc141dd7/yara_x-1.4.0-pp310-pypy310_pp73-macosx_10_15_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7c0d61044a5218b0156c97aa6e35cb649300e276ac161e8daf191f46b21b546b",
"md5": "5ec4e3c676c28600963238f90b6c4dbe",
"sha256": "e95e99da87d38f75ce2b17abb8a62d529041562c5af5d852d9c8d73fe0da9714"
},
"downloads": -1,
"filename": "yara_x-1.4.0-pp310-pypy310_pp73-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "5ec4e3c676c28600963238f90b6c4dbe",
"packagetype": "bdist_wheel",
"python_version": "pp310",
"requires_python": ">=3.9",
"size": 7731045,
"upload_time": "2025-07-10T07:19:16",
"upload_time_iso_8601": "2025-07-10T07:19:16.934055Z",
"url": "https://files.pythonhosted.org/packages/7c/0d/61044a5218b0156c97aa6e35cb649300e276ac161e8daf191f46b21b546b/yara_x-1.4.0-pp310-pypy310_pp73-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "aec0cd267d1e65883ac9e6083d0884b5f609f59f1f166f1508f66bbe7167ccbe",
"md5": "6fcee6aea82544500774aaf1cd83aef4",
"sha256": "beb2d97427314105e307f66d76fbf15ef4da00841cf35f253cb01fcd48500f3f"
},
"downloads": -1,
"filename": "yara_x-1.4.0-pp310-pypy310_pp73-manylinux_2_28_aarch64.whl",
"has_sig": false,
"md5_digest": "6fcee6aea82544500774aaf1cd83aef4",
"packagetype": "bdist_wheel",
"python_version": "pp310",
"requires_python": ">=3.9",
"size": 8524076,
"upload_time": "2025-07-10T07:19:19",
"upload_time_iso_8601": "2025-07-10T07:19:19.210165Z",
"url": "https://files.pythonhosted.org/packages/ae/c0/cd267d1e65883ac9e6083d0884b5f609f59f1f166f1508f66bbe7167ccbe/yara_x-1.4.0-pp310-pypy310_pp73-manylinux_2_28_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f48b82d31452c5e3f0bc2500c27f0bd702cc4e5f5f54ee56d1193996a18e6ab7",
"md5": "cd2c1828474b2889001dbf44672ed62a",
"sha256": "ba880dca64df189d8fe89265150003646048957875e4f30290e7f00aeb67088f"
},
"downloads": -1,
"filename": "yara_x-1.4.0-pp310-pypy310_pp73-manylinux_2_28_x86_64.whl",
"has_sig": false,
"md5_digest": "cd2c1828474b2889001dbf44672ed62a",
"packagetype": "bdist_wheel",
"python_version": "pp310",
"requires_python": ">=3.9",
"size": 9081231,
"upload_time": "2025-07-10T07:19:21",
"upload_time_iso_8601": "2025-07-10T07:19:21.480258Z",
"url": "https://files.pythonhosted.org/packages/f4/8b/82d31452c5e3f0bc2500c27f0bd702cc4e5f5f54ee56d1193996a18e6ab7/yara_x-1.4.0-pp310-pypy310_pp73-manylinux_2_28_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f0ea68d8459ff6515ae720ce9c2e212ebd1bd45c7af73942eb273db471c0b181",
"md5": "73e712efd607a60398f9de19963fdecc",
"sha256": "24e12c4c28bbe21a4c2bc2aa4727971fda8283aa335476d743769b4be0d852a6"
},
"downloads": -1,
"filename": "yara_x-1.4.0-pp310-pypy310_pp73-win_amd64.whl",
"has_sig": false,
"md5_digest": "73e712efd607a60398f9de19963fdecc",
"packagetype": "bdist_wheel",
"python_version": "pp310",
"requires_python": ">=3.9",
"size": 7041115,
"upload_time": "2025-07-10T07:19:23",
"upload_time_iso_8601": "2025-07-10T07:19:23.503368Z",
"url": "https://files.pythonhosted.org/packages/f0/ea/68d8459ff6515ae720ce9c2e212ebd1bd45c7af73942eb273db471c0b181/yara_x-1.4.0-pp310-pypy310_pp73-win_amd64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-10 07:19:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "VirusTotal",
"github_project": "yara-x",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "yara-x"
}