Update pyproject.toml and remove requirements and setup files

.github/workflows/install.yml

@@ -20,12 +20,8 @@ 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 .
 
     - name: Run volatility3
-      run: vol --help
+      run: vol --help

.github/workflows/test.yaml

@@ -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: |

.readthedocs.yml

@@ -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

MANIFEST.in

@@ -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

README.md

@@ -18,62 +18,44 @@ the Volatility Software License (VSL). See the
 [LICENSE](https://www.volatilityfoundation.org/license/vsl-v1.0) file for 
 more details.
 
-## Requirements
+## Installing
 
-Volatility 3 requires Python 3.8.0 or later. To install the most minimal set of dependencies (some plugins will not work) use a command such as:
+Volatility 3 requires Python 3.8.0 or later and is published on the [PyPi registry](https://pypi.org/project/volatility3).
 
 ```shell
-pip3 install -r requirements-minimal.txt
+pip install volatility3
 ```
 
-Alternately, the minimal packages will be installed automatically when Volatility 3 is installed using pip. However, as noted in the Quick Start section below, Volatility 3 does not *need* to be installed prior to using it.
+If you want to use the latest development version of Volatility 3 we recommend you manually clone this repository and install an editable version of the project.
+We recommend you use a virtual environment to keep installed dependencies separate from system packages.
 
-```shell
-pip3 install .
-```
-
-To enable the full range of Volatility 3 functionality, use a command like the one below. For partial functionality, comment out any unnecessary packages in [requirements.txt](requirements.txt) prior to running the command.
-
-```shell
-pip3 install -r requirements.txt
-```
-
-## Downloading Volatility
-
-The latest stable version of Volatility will always be the stable branch of the GitHub repository. You can get the latest version of the code using the following command:
+The latest stable version of Volatility will always be the `stable` branch of the GitHub repository. The default branch is `develop`.
 
 ```shell
 git clone https://github.com/volatilityfoundation/volatility3.git
+cd volatility3/
+python3 -m venv venv && . venv/bin/activate
+pip install -e .[dev]
 ```
 
 ## Quick Start
 
-1. Clone the latest version of Volatility from GitHub:
-
-    ```shell
-    git clone https://github.com/volatilityfoundation/volatility3.git
-    ```
+1. Install Volatility 3 as documented in the Installing section of the readme.
 
 2. See available options:
 
     ```shell
-    python3 vol.py -h
+    vol -h
     ```
 
-3. To get more information on a Windows memory sample and to make sure
-Volatility supports that sample type, run
-`python3 vol.py -f <imagepath> windows.info`
-
-   Example:
+3. To get more information on a Windows memory sample and to make sure Volatility supports that sample type, run `vol -f <imagepath> windows.info`:
 
     ```shell
-    python3 vol.py -f /home/user/samples/stuxnet.vmem windows.info
+    vol -f /home/user/samples/stuxnet.vmem windows.info
     ```
 
-4. Run some other plugins. The `-f` or `--single-location` is not strictly
-required, but most plugins expect a single sample. Some also
-require/accept other options.  Run `python3 vol.py <plugin> -h`
-for more information on a particular command.
+4. Run some other plugins. The `-f` or `--single-location` is not strictly required, but most plugins expect a single sample.
+Some also require/accept other options.  Run `vol <plugin> -h` for more information on a particular command.
 
 ## Symbol Tables
 

pyproject.toml

@@ -8,25 +8,68 @@ authors = [
 ]
 requires-python = ">=3.8.0"
 license = { text = "VSL" }
-dynamic = ["dependencies", "optional-dependencies", "version"]
+dynamic = ["version"]
+
+dependencies = [
+    "pefile>=2024.8.26",
+]
+
+[project.optional-dependencies]
+full = [
+    "yara-python>=4.5.1,<5",
+    "capstone>=5.0.3,<6",
+    "pycryptodome>=3.21.0,<4",
+    "leechcorepyc>=2.19.2,<3; sys_platform != 'darwin'",
+]
+
+cloud = [
+    "gcsfs>=2024.10.0",
+    "s3fs>=2024.10.0",
+]
+
+dev = [
+    "volatility3[full,cloud]",
+    "jsonschema>=4.23.0,<5",
+    "pyinstaller>=6.11.0,<7",
+    "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/"
-"Bug Tracker" = "https://github.com/volatilityfoundation/volatility3/issues"
-Documentation = "https://volatility3.readthedocs.io/"
-"Source Code" = "https://github.com/volatilityfoundation/volatility3"
+homepage = "https://github.com/volatilityfoundation/volatility3/"
+documentation = "https://volatility3.readthedocs.io/"
+repository = "https://github.com/volatilityfoundation/volatility3"
+issues = "https://github.com/volatilityfoundation/volatility3/issues"
 
 [project.scripts]
 vol = "volatility3.cli:main"
 volshell = "volatility3.cli.volshell:main"
 
 [tool.setuptools.dynamic]
 version = { attr = "volatility3.framework.constants._version.PACKAGE_VERSION" }
-dependencies = { file = "requirements-minimal.txt" }
 
 [tool.setuptools.packages.find]
 include = ["volatility3*"]
 
+[tool.mypy]
+mypy_path = "./stubs"
+show_traceback = true
+
+[tool.mypy.overrides]
+ignore_missing_imports = true
+
 [build-system]
 requires = ["setuptools>=68"]
 build-backend = "setuptools.build_meta"

test/README.md

@@ -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: