Changed tools to entry points (#606)

ForensicArtifacts · Jan 28, 2024 · 71669ea · 71669ea
1 parent b8f4698
commit 71669ea
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 26 deletions.
diff --git a/tools/__init__.py → artifacts/scripts/__init__.py b/tools/__init__.py → artifacts/scripts/__init__.py
diff --git a/tools/stats.py → artifacts/scripts/stats.py b/tools/stats.py → artifacts/scripts/stats.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-"""Report statistics about the artifact collection."""
+"""Console script to collect statistics about definitions."""
 
 import collections
 import os
@@ -122,18 +122,15 @@ def PrintStats(self):
 
 
 def Main():
-  """The main program function.
+  """Entry point of console script to collect statistics about definitions.
 
   Returns:
-    bool: True if successful or False if not.
+    int: exit code that is provided to sys.exit().
   """
   statsbuilder = ArtifactStatistics()
   statsbuilder.PrintStats()
-  return True
+  return 0
 
 
 if __name__ == '__main__':
-  if not Main():
-    sys.exit(1)
-  else:
-    sys.exit(0)
+  sys.exit(Main())
diff --git a/tools/validator.py → artifacts/scripts/validator.py b/tools/validator.py → artifacts/scripts/validator.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-"""Tool to validate artifact definitions."""
+"""Console script to validate artifact definitions."""
 
 import argparse
 import glob
@@ -556,10 +556,10 @@ def GetUndefinedArtifacts(self):
 
 
 def Main():
-  """The main program function.
+  """Entry point of console script to collect statistics about definitions.
 
   Returns:
-    bool: True if successful or False if not.
+    int: exit code that is provided to sys.exit().
   """
   args_parser = argparse.ArgumentParser(
       description='Validates an artifact definitions file.')
@@ -576,12 +576,12 @@ def Main():
     print('')
     args_parser.print_help()
     print('')
-    return False
+    return 1
 
   if not os.path.exists(options.definitions):
     print(f'No such file or directory: {options.definitions:s}')
     print('')
-    return False
+    return 1
 
   validator = ArtifactDefinitionsValidator()
 
@@ -595,14 +595,11 @@ def Main():
 
   if not result:
     print('FAILURE')
-    return False
+    return 1
 
   print('SUCCESS')
-  return True
+  return 0
 
 
 if __name__ == '__main__':
-  if not Main():
-    sys.exit(1)
-  else:
-    sys.exit(0)
+  sys.exit(Main())
diff --git a/setup.cfg b/setup.cfg
@@ -23,9 +23,6 @@ package_dir =
   artifacts = artifacts
 packages = find:
 python_requires = >=3.7
-scripts =
-  tools/stats.py
-  tools/validator.py
 
 [options.package_data]
 artifacts =
@@ -39,6 +36,11 @@ exclude =
   utils
 where = .
 
+[options.entry_points]
+console_scripts =
+  stats = artifacts.scripts.stats:Main
+  validator = artifacts.scripts.validator:Main
+
 [bdist_rpm]
 release = 1
 packager = Forensic artifacts <[email protected]>

diff --git a/tests/validator_test.py b/tests/validator_test.py
@@ -7,7 +7,7 @@
 import unittest
 
 from artifacts import errors
-from tools import validator
+from artifacts.scripts import validator
 
 from tests import test_lib
 

diff --git a/tox.ini b/tox.ini
@@ -60,6 +60,6 @@ commands =
   docformatter --version
   pylint --version
   yamllint -v
-  docformatter --check --diff --recursive artifacts setup.py tests tools
-  pylint --rcfile=.pylintrc artifacts setup.py tests tools
+  docformatter --check --diff --recursive artifacts setup.py tests
+  pylint --rcfile=.pylintrc artifacts setup.py tests
   yamllint -c .yamllint.yaml artifacts/data test_data
diff --git a/utils/update_release.sh b/utils/update_release.sh
@@ -23,7 +23,7 @@ artifacts (${VERSION}-1) unstable; urgency=low
 EOT
 
 # Regenerate the statistics documentation.
-PYTHONPATH=. ./tools/stats.py > docs/sources/background/Stats.md
+PYTHONPATH=. ./artifacts/scripts/stats.py > docs/sources/background/Stats.md
 
 # Regenerate the API documentation.
 tox -edocs