This commit is contained in:
lesander
2024-11-08 14:03:08 +01:00
parent 1fd5177260
commit a04c04c4e3
8 changed files with 24 additions and 36 deletions
-4
View File
@@ -20,10 +20,6 @@ jobs:
- name: Setup python-pip
run: python -m pip install --upgrade pip
- name: Install dependencies
run: |
pip install -r requirements.txt
- name: Install volatility3
run: pip install .
+2 -4
View File
@@ -16,10 +16,8 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install Cmake
pip install build
pip install -r ./test/requirements-testing.txt
python -m pip install --upgrade pip Cmake build
pip install .[test]
- name: Build PyPi packages
run: |
+4 -1
View File
@@ -20,4 +20,7 @@ build:
# Optionally set the version of Python and requirements required to build your docs
python:
install:
- requirements: doc/requirements.txt
- method: pip
path: .
extra_requirements:
- docs
+1 -1
View File
@@ -1,6 +1,6 @@
prune development
include * .*
include doc/make.bat doc/Makefile doc/requirements.txt
include pyproject.toml doc/make.bat doc/Makefile
recursive-include doc/source *
recursive-include volatility3 *.json
recursive-exclude doc/source volatility3.*.rst
-9
View File
@@ -1,9 +0,0 @@
# These packages are required for building the documentation.
sphinx>=4.0.0,<7
sphinx_autodoc_typehints>=1.4.0
sphinx-rtd-theme>=0.4.3
yara-python
yara-x
pycryptodome
pefile
+14 -1
View File
@@ -8,7 +8,7 @@ authors = [
]
requires-python = ">=3.9.0"
license = { text = "VSL" }
dynamic = ["dependencies", "optional-dependencies", "version"]
dynamic = ["version"]
dependencies = [
"pefile>=2024.8.26",
@@ -34,6 +34,19 @@ dev = [
"pyinstaller-hooks-contrib>=2024.9",
]
test = [
"volatility3[dev]",
"pytest>=8.3.3,<9",
"yara-x>=0.10.0,<1",
]
docs = [
"volatility3[dev]",
"sphinx>=8.0.0,<7",
"sphinx-autodoc-typehints>=2.5.0,<3",
"sphinx-rtd-theme>=3.0.1,<4",
]
[project.urls]
homepage = "https://github.com/volatilityfoundation/volatility3/"
documentation = "https://volatility3.readthedocs.io/"
+2 -4
View File
@@ -2,14 +2,12 @@
## Requirements
The Volatility 3 Testing Framework requires the same version of Python as Volatility3 itself. To install the current set of dependencies that the framework requires, use a command like this:
The Volatility 3 Testing Framework requires the same version of Python as Volatility 3 itself. To install the current set of dependencies that the framework requires, use a command like this:
```shell
pip3 install -r requirements-testing.txt
pip3 install -e .[test]
```
NOTE: `requirements-testing.txt` can be found in this current `test/` directory.
## Quick Start: Manual Testing
1. To test Volatility 3 on an image, first download one with a command such as:
-11
View File
@@ -1,11 +0,0 @@
# These packages are required for core functionality.
pefile>=2017.8.1 #foo
# The following packages are optional.
# If certain packages are not necessary, place a comment (#) at the start of the line.
# This is required for the yara plugins
yara-python>=3.8.0
yara-x>=0.5.0
pytest>=7.0.0