Yara-python without Yara installed

Open
#188 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Compare the installation guidance in the Yara-python README with the linked YARA Python documentation, focusing on whether a separately installed YARA build is required. Clarify the dependency relationship and update the contradictory wording so users can determine the required setup.

Written by the indexing model from the issue text.

Description

I find the documentation on Yara-python and Yara contradictory.
Is it necessary to have Yara compiled and installed for Yara-python to work properly?

From Yara Docs:

YARA can be also used from Python through the yara-python library. Once the library is built and installed as described in Compiling and installing YARA you'll have access to the full potential of YARA from your Python scripts.

From Yara-python readme

With this library you can use YARA from your Python programs. It covers all YARA's features, from compiling, saving and loading rules to scanning files, strings and processes.

Personally I'm running Yara-python without Yara installed and I have not encountered any problems

Dominant language
C
Stars
754
Forks
190
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from VirusTotal/yara-python

All issues in VirusTotal/yara-python

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.