From 67304a30291db9fefe05377cbacd058409d2e6b9 Mon Sep 17 00:00:00 2001 From: Greg DiCristofaro Date: Mon, 25 Jan 2021 15:25:01 -0500 Subject: [PATCH] added requirements file and updated documentation --- release_scripts/localization_scripts/README.md | 2 +- .../localization_scripts/allbundlesscript.py | 5 +++-- .../localization_scripts/diffscript.py | 5 +++-- .../localization_scripts/requirements.txt | Bin 0 -> 472 bytes .../localization_scripts/updatepropsscript.py | 5 +++-- 5 files changed, 10 insertions(+), 7 deletions(-) create mode 100644 release_scripts/localization_scripts/requirements.txt diff --git a/release_scripts/localization_scripts/README.md b/release_scripts/localization_scripts/README.md index 531aaab574..11fd925e4c 100644 --- a/release_scripts/localization_scripts/README.md +++ b/release_scripts/localization_scripts/README.md @@ -9,7 +9,7 @@ All of these scripts provide more details on usage by calling the script with `- ## Dependencies -These scripts require the python libraries: gitpython, jproperties, pyexcel-xlsx, xlsxwriter and pyexcel along with python >= 3.9.1. The virtual environment to set up dependencies can be activated with venv/Scripts/activate. As a consequence of gitpython, this project also requires git >= 1.7.0. +This script requires the python libraries: gitpython, jproperties, pyexcel-xlsx, xlsxwriter and pyexcel along with python >= 3.9.1 or the requirements.txt file found in this directory can be used (more information on that can be found [here](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#using-requirements-files)). As a consequence of gitpython, this project also requires git >= 1.7.0. ## Basic Localization Update Workflow diff --git a/release_scripts/localization_scripts/allbundlesscript.py b/release_scripts/localization_scripts/allbundlesscript.py index 70fd4ed5f5..99ed3fb6a1 100644 --- a/release_scripts/localization_scripts/allbundlesscript.py +++ b/release_scripts/localization_scripts/allbundlesscript.py @@ -1,8 +1,9 @@ """This script finds all '.properties-MERGED' files and writes relative path, key, and value to a CSV file. This script requires the python libraries: gitpython, jproperties, pyexcel-xlsx, xlsxwriter and pyexcel along with -python >= 3.9.1 or the virtual environment can be used by activating venv/Scripts/activate. As a -consequence of gitpython, it also requires git >= 1.7.0. +python >= 3.9.1 or the requirements.txt file found in this directory can be used +(https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#using-requirements-files). As a +consequence of gitpython, this project also requires git >= 1.7.0. This script relies on fetching 'HEAD' from current branch. So make sure repo is on correct branch (i.e. develop). """ diff --git a/release_scripts/localization_scripts/diffscript.py b/release_scripts/localization_scripts/diffscript.py index e77f170a55..bab6291d2a 100644 --- a/release_scripts/localization_scripts/diffscript.py +++ b/release_scripts/localization_scripts/diffscript.py @@ -2,8 +2,9 @@ and generates a csv file containing the items changed. This script requires the python libraries: gitpython, jproperties, pyexcel-xlsx, xlsxwriter and pyexcel along with -python >= 3.9.1 or the virtual environment can be used by activating venv/Scripts/activate. As a -consequence of gitpython, it also requires git >= 1.7.0. +python >= 3.9.1 or the requirements.txt file found in this directory can be used +(https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#using-requirements-files). As a +consequence of gitpython, this project also requires git >= 1.7.0. """ import sys from envutil import get_proj_dir diff --git a/release_scripts/localization_scripts/requirements.txt b/release_scripts/localization_scripts/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..01d9ca0c9e37e799e1f33f35ea50c1e7c0fd4ae6 GIT binary patch literal 472 zcmZuuyAFat5S-e?Pr>lEvbMF;77-P~D{uw;ygIuJi6-W9N5VXIZtndm;NW3GgBo{~ zJPRDS0_@;(2iRhR2N8!Gu8PGAmMC^q?1Y(&CpxssiBv24P+1k#IWqdM?&4zZ6?zO* z_MAP?rQ~;1UbwjU>QQS-(OWV}DCtbuQa|%1HbLeKD^-Rd1+ko`;fDRkJtpXM{>qB~ zxJYX?b51`@OEl8K{!5Pm5=|pnN8X`f5520^l;-a=qhkXZoBn=@l=?_BT$Y(= 3.9.1 or the virtual environment can be used by activating venv/Scripts/activate. As a -consequence of gitpython, it also requires git >= 1.7.0. +python >= 3.9.1 or the requirements.txt file found in this directory can be used +(https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#using-requirements-files). As a +consequence of gitpython, this project also requires git >= 1.7.0. """ from typing import List, Dict, Tuple, Callable, Iterator, Union