Merge pull request #430 from volatilityfoundation/issues/release-namespace

Rename the base namespace as volatility3

Author: ikelos

.gitignore

@@ -4,7 +4,7 @@ __pycache__
 
 # Sphinx generated files
 doc/build
-doc/source/volatility.*
+doc/source/volatility3.*
 
 # Pycharm/PyDev development files
 workspace.xml
@@ -14,14 +14,14 @@ workspace.xml
 # Manually generated files
 .mypy_cache
 stubs
-volatility/symbols/linux*
-volatility/symbols/windows*
-volatility/symbols/mac*
+volatility3/symbols/linux*
+volatility3/symbols/windows*
+volatility3/symbols/mac*
 
 # Mac metadata files
 .DS_Store
 
-# Volatility's config 
+# Volatility's config
 config*.json
 
 # Pyinstaller files

development/schema_validate.py

@@ -17,7 +17,7 @@
 logger.addHandler(console)
 logger.setLevel(logging.DEBUG)
 
-from volatility import schemas
+from volatility3 import schemas
 
 if __name__ == '__main__':
     parser = argparse.ArgumentParser("Validates ")

doc/Makefile

@@ -15,7 +15,7 @@ help:
 
 # Ensure we clean the autodoc files when we clean
 clean:
-	-rm source/volatility.*.rst
+	-rm source/volatility3.*.rst
 	@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 # Catch-all target: route all unknown targets to Sphinx using the new

doc/source/conf.py

@@ -21,18 +21,18 @@
 
 
 def setup(app):
-    volatility_directory = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', 'volatility'))
+    volatility_directory = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', 'volatility3'))
 
     source_dir = os.path.abspath(os.path.dirname(__file__))
     sphinx.ext.apidoc.main(argv = ['-e', '-M', '-f', '-T', '-o', source_dir, volatility_directory])
 
-    # Go through the volatility.framework.plugins files and change them to volatility.plugins
+    # Go through the volatility3.framework.plugins files and change them to volatility3.plugins
     for dir, _, files in os.walk(os.path.dirname(__file__)):
         for filename in files:
-            if filename.startswith('volatility.framework.plugins') and filename != 'volatility.framework.plugins.rst':
-                # Change all volatility.framework.plugins to volatility.plugins in the file
+            if filename.startswith('volatility3.framework.plugins') and filename != 'volatility3.framework.plugins.rst':
+                # Change all volatility3.framework.plugins to volatility3.plugins in the file
                 # Rename the file
-                new_filename = filename.replace('volatility.framework.plugins', 'volatility.plugins')
+                new_filename = filename.replace('volatility3.framework.plugins', 'volatility3.plugins')
 
                 replace_string = b"Submodules\n----------\n\n.. toctree::\n\n"
                 submodules = replace_string
@@ -48,25 +48,25 @@ def setup(app):
                 with open(os.path.join(dir, new_filename), 'wb') as newfile:
                     with open(os.path.join(dir, filename), "rb") as oldfile:
                         line = oldfile.read()
-                        correct_plugins = line.replace(b'volatility.framework.plugins', b'volatility.plugins')
+                        correct_plugins = line.replace(b'volatility3.framework.plugins', b'volatility3.plugins')
                         correct_submodules = correct_plugins.replace(replace_string, submodules)
                         newfile.write(correct_submodules)
                     os.remove(os.path.join(dir, filename))
-            elif filename == 'volatility.framework.rst':
+            elif filename == 'volatility3.framework.rst':
                 with open(os.path.join(dir, filename), "rb") as contents:
                     lines = contents.readlines()
                 plugins_seen = False
                 with open(os.path.join(dir, filename), "wb") as contents:
                     for line in lines:
-                        if b'volatility.framework.plugins' in line:
+                        if b'volatility3.framework.plugins' in line:
                             plugins_seen = True
                         if plugins_seen and line == b'':
-                            contents.write(b'   volatility.plugins')
+                            contents.write(b'   volatility3.plugins')
                         contents.write(line)
-            elif filename == 'volatility.plugins.rst':
+            elif filename == 'volatility3.plugins.rst':
                 with open(os.path.join(dir, filename), "rb") as contents:
                     lines = contents.readlines()
-                with open(os.path.join(dir, 'volatility.framework.plugins.rst'), "rb") as contents:
+                with open(os.path.join(dir, 'volatility3.framework.plugins.rst'), "rb") as contents:
                     real_lines = contents.readlines()
 
                 # Process real_lines
@@ -82,15 +82,15 @@ def setup(app):
                     for line in lines:
                         contents.write(line)
                     for line in submodule_lines:
-                        contents.write(line.replace(b'volatility.framework.plugins', b'volatility.plugins'))
+                        contents.write(line.replace(b'volatility3.framework.plugins', b'volatility3.plugins'))
 
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath('../..'))
 
-from volatility.framework import constants
+from volatility3.framework import constants
 
 # -- General configuration ------------------------------------------------
 

doc/source/index.rst

@@ -5,7 +5,7 @@ This is the documentation for Volatility 3, the most advanced memory forensics
 framework in the world. Like previous versions of the Volatility framework,
 Volatility 3 is Open Source.
 
-:doc:`List of plugins <volatility.plugins>`
+:doc:`List of plugins <volatility3.plugins>`
 
 Here are some guidelines for using Volatility 3 effectively:
 
@@ -22,7 +22,7 @@ Python Packages
 ===============
 
 .. toctree::
-    volatility
+    volatility3
 
 Indices and tables
 ==================

setup.py

@@ -4,9 +4,9 @@
 
 import setuptools
 
-from volatility.framework import constants
+from volatility3.framework import constants
 
-setuptools.setup(name = "volatility",
+setuptools.setup(name = "volatility3",
                  description = "Memory forensics framework",
                  version = constants.PACKAGE_VERSION,
                  license = "VSL",
@@ -27,8 +27,8 @@
                  packages = setuptools.find_packages(exclude = ["development", "development.*"]),
                  entry_points = {
                      'console_scripts': [
-                         'vol = volatility.cli:main',
-                         'volshell = volatility.cli.volshell:main',
+                         'vol = volatility3.cli:main',
+                         'volshell = volatility3.cli.volshell:main',
                      ],
                  },
                  install_requires = ["pefile"],

vol.py

@@ -4,7 +4,7 @@
 # which is available at https://www.volatilityfoundation.org/license/vsl-v1.0
 #
 
-import volatility.cli
+import volatility3.cli
 
 if __name__ == '__main__':
-    volatility.cli.main()
+    volatility3.cli.main()

vol.spec

@@ -31,15 +31,15 @@ sys.path.append(os.getcwd())
 vol_analysis = Analysis(['vol.py'],
                         pathex = [],
                         binaries = binaries,
-                        datas = collect_data_files('volatility.framework') + \
-                                collect_data_files('volatility.framework.automagic', include_py_files = True) + \
-                                collect_data_files('volatility.framework.plugins', include_py_files = True) + \
-                                collect_data_files('volatility.framework.layers', include_py_files = True) + \
-                                collect_data_files('volatility.schemas') + \
-                                collect_data_files('volatility.plugins', include_py_files = True),
-                        hiddenimports = collect_submodules('volatility.framework.automagic') + \
-                                        collect_submodules('volatility.framework.plugins') + \
-                                        collect_submodules('volatility.framework.symbols'),
+                        datas = collect_data_files('volatility3.framework') + \
+                                collect_data_files('volatility3.framework.automagic', include_py_files = True) + \
+                                collect_data_files('volatility3.framework.plugins', include_py_files = True) + \
+                                collect_data_files('volatility3.framework.layers', include_py_files = True) + \
+                                collect_data_files('volatility3.schemas') + \
+                                collect_data_files('volatility3.plugins', include_py_files = True),
+                        hiddenimports = collect_submodules('volatility3.framework.automagic') + \
+                                        collect_submodules('volatility3.framework.plugins') + \
+                                        collect_submodules('volatility3.framework.symbols'),
                         hookspath = [],
                         runtime_hooks = [],
                         excludes = [],
@@ -55,16 +55,16 @@ vol_analysis = Analysis(['vol.py'],
 # volshell_analysis = Analysis(['volshell.py'],
 #                              pathex = [],
 #                              binaries = [],
-#                              datas = collect_data_files('volatility.framework') + \
-#                                      collect_data_files('volatility.framework.automagic', include_py_files = True) + \
-#                                      collect_data_files('volatility.framework.plugins', include_py_files = True) + \
-#                                      collect_data_files('volatility.framework.layers', include_py_files = True) + \
-#                                      collect_data_files('volatility.cli', include_py_files = True) + \
-#                                      collect_data_files('volatility.schemas') + \
-#                                      collect_data_files('volatility.plugins', include_py_files = True),
-#                              hiddenimports = collect_submodules('volatility.framework.automagic') + \
-#                                              collect_submodules('volatility.framework.plugins') + \
-#                                              collect_submodules('volatility.framework.symbols'),
+#                              datas = collect_data_files('volatility3.framework') + \
+#                                      collect_data_files('volatility3.framework.automagic', include_py_files = True) + \
+#                                      collect_data_files('volatility3.framework.plugins', include_py_files = True) + \
+#                                      collect_data_files('volatility3.framework.layers', include_py_files = True) + \
+#                                      collect_data_files('volatility3.cli', include_py_files = True) + \
+#                                      collect_data_files('volatility3.schemas') + \
+#                                      collect_data_files('volatility3.plugins', include_py_files = True),
+#                              hiddenimports = collect_submodules('volatility3.framework.automagic') + \
+#                                              collect_submodules('volatility3.framework.plugins') + \
+#                                              collect_submodules('volatility3.framework.symbols'),
 #                              hookspath = [],
 #                              runtime_hooks = [],
 #                              excludes = [],

volatility/__init__.py volatility3/__init__.pyvolatility/__init__.py renamed to volatility3/__init__.py

@@ -35,8 +35,8 @@ class WarningFindSpec(abc.MetaPathFinder):
     def find_spec(fullname: str, path: Optional[List[str]], target: None = None, **kwargs) -> None:
         """Mock find_spec method that just checks the name, this must go
         first."""
-        if fullname.startswith("volatility.framework.plugins."):
-            warning = "Please do not use the volatility.framework.plugins namespace directly, only use volatility.plugins"
+        if fullname.startswith("volatility3.framework.plugins."):
+            warning = "Please do not use the volatility3.framework.plugins namespace directly, only use volatility3.plugins"
             # Pyinstaller uses walk_packages to import, but needs to read the modules to figure out dependencies
             # As such, we only print the warning when directly imported rather than from within walk_packages
             if inspect.stack()[-2].function != 'walk_packages':
@@ -46,17 +46,17 @@ def find_spec(fullname: str, path: Optional[List[str]], target: None = None, **k
 warning_find_spec = [WarningFindSpec()]  # type: List[abc.MetaPathFinder]
 sys.meta_path = warning_find_spec + sys.meta_path
 
-# We point the volatility.plugins __path__ variable at BOTH
-#   volatility/plugins
-#   volatility/framework/plugins
+# We point the volatility3.plugins __path__ variable at BOTH
+#   volatility3/plugins
+#   volatility3/framework/plugins
 # in that order.
 #
 # This will allow our users to override any component of any plugin without monkey patching,
 # but it also allows us to clear out the plugins directory to get back to proper functionality.
 # This offered the greatest flexibility for users whilst allowing us to keep the core separate and clean.
 #
-# This means that all plugins should be imported as volatility.plugins (otherwise they'll be imported twice,
-# once as volatility.plugins.NAME and once as volatility.framework.plugins.NAME).  We therefore throw an error
-# if anyone tries to import anything under the volatility.framework.plugins.* namespace
+# This means that all plugins should be imported as volatility3.plugins (otherwise they'll be imported twice,
+# once as volatility3.plugins.NAME and once as volatility3.framework.plugins.NAME).  We therefore throw an error
+# if anyone tries to import anything under the volatility3.framework.plugins.* namespace
 #
-# The remediation is to only ever import form volatility.plugins instead.
+# The remediation is to only ever import form volatility3.plugins instead.