added requirements file and updated documentation

This commit is contained in:
Greg DiCristofaro 2021-01-25 15:25:01 -05:00
parent 9365749d61
commit 67304a3029
5 changed files with 10 additions and 7 deletions

View File

@ -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

View File

@ -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).
"""

View File

@ -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

Binary file not shown.

View File

@ -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.
"""
from typing import List, Dict, Tuple, Callable, Iterator, Union