1 2This directory contains set of scripts to facilitate project synchronization and 3mirroring in a Python package. 4 5The scripts require Python 3 and they rely on a binary/symlink python3 to be 6present that points to the latest Python 3.x version present on the system. 7 8All the scripts in the package are installed with the 'opengrok-' prefix. 9 10See https://github.com/oracle/opengrok/wiki/Repository-synchronization for more 11details. 12 13The instructions below are pretty much standard way how to deal with Python 14packages however may come handy if you never encountered Python package before. 15 16Install 17------- 18 19* Installation on the target system so that the package is globally available: 20 21Use the distribution tarball and run pip: 22 23 python3 -m pip install opengrok-tools.tar.gz 24 25This will download all dependencies and install the package to your local 26python3 modules. 27 28* Installing to a specified directory: 29 30You can also install the tools to a specified directory, we suggest you to use 31the python virtual environment for it: 32 33 cd /opt/opengrok 34 python3 -m venv opengrok-tools 35 opengrok-tools/bin/python -m pip install opengrok-tools.tar.gz 36 37This will install the package and all the dependencies under the 38/opt/opengrok/opengrok-tools directory. You can then call the scripts with 39 40/opt/opengrok/opengrok-tools/bin/opengrok-indexer 41/opt/opengrok/opengrok-tools/bin/opengrok-groups 42... 43 44Uninstall 45--------- 46 47* from system level package or from venv: 48 (assuming the venv is activated or you are running python3 from the venv 49 binary directory) 50 51 python3 -m pip uninstall opengrok_tools 52 53