moving all package to opengrok-tools

Author: tulinkry

opengrok-tools/setup.py

@@ -23,15 +23,15 @@ def my_test_suite():
     version='1.1rc63',
     packages=[
         'opengrok_tools',
-        'all',
-        'all.utils',
-        'all.scm',
+        'opengrok_tools.all',
+        'opengrok_tools.all.utils',
+        'opengrok_tools.all.scm',
     ],
     package_dir={
         'opengrok_tools': 'src/main/python/opengrok_tools',
-        'all': 'src/main/python/opengrok_tools/all',
-        'all.scm': 'src/main/python/opengrok_tools/all/scm',
-        'all.utils': 'src/main/python/opengrok_tools/all/utils',
+        'opengrok_tools.all': 'src/main/python/opengrok_tools/all',
+        'opengrok_tools.all.scm': 'src/main/python/opengrok_tools/all/scm',
+        'opengrok_tools.all.utils': 'src/main/python/opengrok_tools/all/utils',
     },
     url='https://github.com/OpenGrok/OpenGrok',
     license='CDDL',

opengrok-tools/src/main/python/README.md

@@ -45,13 +45,29 @@ python -m pip install -r requirements.txt
 
 ## Developing
 
-Start developing, making changes in files. Test your changes with usual python commands.
+When you start developing, install the package in a development mode.
 
 ```bash
-python src/main/python/opengrok_tools/groups.py
-python src/main/python/opengrok_tools/sync.py
+python setup.py develop
 ```
 
+This installs the package however keeping the links directly to your source,
+so you can edit the files and see the immediate results.
+
+Start developing, making changes in files. Test your changes with calling the entry points.
+
+```bash
+export PYTHONPATH=`pwd`/src/main/python:$PYTHONPATH
+opengrok-groups
+opengrok-sync
+```
+
+It is necessary to set the python path as the python interpreter is not able to find the packages
+in our provided structure on its own.
+
+Also you call the opengrok tools scripts by the entry points then (`opengrok-groups`, ...).
+Calling directly the python script `groups.py` would lead to error related to relative imports.
+
 ## Installation
 
 Test installing your package into the local environment

opengrok-tools/src/main/python/opengrok_tools/config_merge.py

@@ -26,7 +26,7 @@
 import os
 import sys
 
-from all.utils.java import Java, get_javaparser
+from .all.utils.java import Java, get_javaparser
 
 """
  Wrapper for Java program merging OpenGrok configuration.

opengrok-tools/src/main/python/opengrok_tools/deploy.py

@@ -29,8 +29,8 @@
 import tempfile
 from shutil import copyfile
 
-from all.utils.command import Command
-from all.utils.utils import get_command
+from .all.utils.command import Command
+from .all.utils.utils import get_command
 
 """
  deploy war file

opengrok-tools/src/main/python/opengrok_tools/groups.py

@@ -26,7 +26,7 @@
 import os
 import sys
 
-from all.utils.java import Java, get_javaparser
+from .all.utils.java import Java, get_javaparser
 
 """
  Script for manipulating project groups

opengrok-tools/src/main/python/opengrok_tools/indexer.py

@@ -28,8 +28,8 @@
 import os
 import sys
 
-from all.utils.indexer import FindCtags, Indexer
-from all.utils.java import get_javaparser
+from .all.utils.indexer import FindCtags, Indexer
+from .all.utils.java import get_javaparser
 
 """
   opengrok.jar wrapper
@@ -39,7 +39,6 @@
 
 
 def main():
-
     parser = argparse.ArgumentParser(description='OpenGrok indexer wrapper',
                                      parents=[get_javaparser()])
     parser.add_argument('-C', '--no_ctags_check', action='store_true',

opengrok-tools/src/main/python/opengrok_tools/java.py

@@ -27,7 +27,7 @@
 import os
 import sys
 
-from all.utils.java import Java, get_javaparser
+from .all.utils.java import Java, get_javaparser
 
 
 def main():

opengrok-tools/src/main/python/opengrok_tools/mirror.py

@@ -37,13 +37,13 @@
 import tempfile
 from logging.handlers import RotatingFileHandler
 
-from all.utils.filelock import Timeout, FileLock
-from all.utils.hook import run_hook
-from all.utils.opengrok import get_repos, get_config_value, get_repo_type
-from all.utils.readconfig import read_config
-from all.utils.repofactory import get_repository
-from all.utils.utils import is_exe, check_create_dir, get_int, diff_list
-from all.scm.repository import RepositoryException
+from .all.utils.filelock import Timeout, FileLock
+from .all.utils.hook import run_hook
+from .all.utils.opengrok import get_repos, get_config_value, get_repo_type
+from .all.utils.readconfig import read_config
+from .all.utils.repofactory import get_repository
+from .all.utils.utils import is_exe, check_create_dir, get_int, diff_list
+from .all.scm.repository import RepositoryException
 
 
 major_version = sys.version_info[0]

opengrok-tools/src/main/python/opengrok_tools/projadm.py

@@ -35,11 +35,11 @@
 import tempfile
 from os import path
 
-from all.utils.command import Command
-from all.utils.filelock import Timeout, FileLock
-from all.utils.opengrok import get_configuration, set_configuration, \
+from .all.utils.command import Command
+from .all.utils.filelock import Timeout, FileLock
+from .all.utils.opengrok import get_configuration, set_configuration, \
     add_project, delete_project, get_config_value
-from all.utils.utils import get_command
+from .all.utils.utils import get_command
 
 MAJOR_VERSION = sys.version_info[0]
 if (MAJOR_VERSION < 3):

opengrok-tools/src/main/python/opengrok_tools/reindex_project.py

@@ -28,9 +28,9 @@
 import sys
 import tempfile
 
-from all.utils.indexer import Indexer
-from all.utils.java import get_javaparser
-from all.utils.opengrok import get_configuration
+from .all.utils.indexer import Indexer
+from .all.utils.java import get_javaparser
+from .all.utils.opengrok import get_configuration
 
 """
  OpenGrok reindexing script for single project. Makes sure it uses