Add in a setup.py and fix up the documentation so setuptools can build it.

This commit is contained in:
Mike Auty
2018-09-01 22:28:03 +01:00
parent 312e74cd08
commit 3713e9484c
3 changed files with 40 additions and 0 deletions
+1
View File
@@ -0,0 +1 @@
prune development
+8
View File
@@ -15,6 +15,14 @@
import os
import sys
import sphinx.apidoc
def setup(app):
sphinx.apidoc.main(argv = ['-e', '-M', '-f', '-T', '-o', 'doc/source',
os.path.join(os.path.dirname(__file__), '..', '..', 'volatility')])
# 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.
+31
View File
@@ -0,0 +1,31 @@
import setuptools
from volatility.framework import constants
setuptools.setup(
name = "volatility",
description = "Memory forensics framework",
version = constants.PACKAGE_VERSION,
license = "VCLA",
keywords = "volatility memory forensics framework windows linux volshell",
author = "Volatility Foundation",
author_email = "volatility@volatilityfoundation.org",
url = "https://volatilityfoundation.org/volatility/",
project_urls = {
"Bug Tracker": "https://github.com/volatilityfoundation/volatility3/issues",
"Documentation": "https://volatilityfoundation.org/volatility/docs/",
"Source Code": "https://github.com/volatilityfoundation/volatility3",
},
include_package_data = True,
exclude_package_data = {'': ['development', 'development.*'],
'development': ['*']},
packages = setuptools.find_packages(exclude = ["developement", "development.*"]),
scripts = [
"vol.py",
"volshell.py"
],
install_requires = [
"pefile"
],
)