diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..be006de --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,13 @@ +# Keep GitHub Actions up to date with GitHub's Dependabot... +# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot +# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem +version: 2 +updates: + - package-ecosystem: github-actions + directory: / + groups: + github-actions: + patterns: + - "*" # Group all Actions updates into a single larger pull request + schedule: + interval: weekly diff --git a/.github/workflows/lint_python.yml b/.github/workflows/lint_python.yml index 4596a47..6536712 100644 --- a/.github/workflows/lint_python.yml +++ b/.github/workflows/lint_python.yml @@ -7,9 +7,9 @@ jobs: - uses: actions/checkout@v3 - uses: actions/setup-python@v4 - run: pip install --upgrade pip setuptools wheel - - run: pip install black codespell mypy pytest ruff safety + - run: pip install codespell mypy pytest ruff safety - run: ruff check --output-format=github --ignore=E501,E701,E713,E722,F401,F403,F405,F841 --line-length=263 . - - run: black --check . || true + - run: ruff format || true - run: codespell --ignore-words-list="datas" --skip="./.git/*" - run: pip install -r requirements.txt - run: mypy --install-types --non-interactive . || true diff --git a/README.md b/README.md index 0701ba9..dc7ada5 100644 --- a/README.md +++ b/README.md @@ -231,11 +231,12 @@ To include the msvcr100.dll to improve the target os compatibility change the li # Use LOKI on Mac OS X (Or later) or Linux -- Create a separate Python environment using [virtualenv](https://docs.python.org/3/library/venv.html) -- Activate the virtual Python environment ```source .env/bin/activate``` -- Install libraries ```pip install colorama yara-python psutil rfc5424-logging-handler netaddr``` -- Run loki-upgrader.py ```python loki-upgrader.py``` -- Run loki ```python loki.py``` + +- Initialize a Python virtual environment for loki. To do this you have to make sure you have the Python module `venv` then run `python -m venv path/to/venv` where `path/to/venv` is the path to your virtual environment. Test your virtual environment by running `path/to/venv/bin/python --version`. +Upgrade your virtual environment modules for `pip`, `setuptools`, and `wheel` by running `path/to/venv/bin/python -m pip install --upgrade pip setuptools wheel`. +- Install libraries ```path/to/venv/bin/python -m pip install colorama yara-python psutil rfc5424-logging-handler netaddr``` +- Run loki-upgrader.py ```path/to/venv/bin/python path/to/loki/loki-upgrader.py``` where `path/to/loki` is the path of the Loki repository. +- Run loki ```sudo path/to/venv/bin/python loki.py``` # Yara sources