Amaril Toolbox

tool box for amaril lab.

Installation and updating

Use the package manager pip to install Amaril Toolbox like below. Rerun this command to check for and install updates with the flag: --upgrade.

pip install git+https://${GITHUB_TOKEN}@github.com/amaril-lab/amariltb

Usage

possible values for version parameter:

• "TEST" - tables used are: "IndexTest", "ProductWordsTest"
• "V1" - tables used are: "Index", "ProductWords"
• "V2" - tables used are: "IndexV2", "ProductWordsV2"

possible values for language parameter:

• "hebrew"
• "english"

Examples of usage of some of the features:

import amariltb

# GET INDEX:
language = 'english'
category = 'animals'
target_filename = 'index_testing.xlsx'
version = 'V1'
amariltb.functions.get_index(language,category,target_filename,version)


# UNIFY WAVES:
bucket_name = "recordings_test"
source_dir = "free/mbh040821/hitId___heb/" 
target_dir = "/Users/shaharhalutz/Documents/Projects/Amaril/amaril-toolkit-module-poc/" 
files_per_chunk = 15
amariltb.functions.unify_waves(bucket_name, source_dir,target_dir,files_per_chunk)

# PROCESS SONIX:
version = "TEST"
language = "english"
category = "animals" 
input_dir = "/yourPathToTheRelevantDirectory/" 
target_filename = 'aDebugFilename.xlsx'
amariltb.functions.process_sonix(input_dir,target_filename, language,category,version)

# PROCESS PRRAT:
version = "TEST"
input_filename = "/yourPathToTheRelevantDirectory/testing_prrat.xlsx"
language = "hebrew"
category = "animals" 
amariltb.functions.process_praat(input_filename, language,category,version)

# ADD TRANSFORM:
version = "TEST"
language = "hebrew"
category = "animals" 
word = "סיח"
transform = "סוס"
amariltb.functions.add_transform(word,transform,category,language,version)

# ADD TRANSFORMS:
version = "TEST"
source_filename =  "/yourPathToTheRelevantDirectory/testing_add_transforms.xlsx"
amariltb.functions.add_transforms(source_filename,version)

# REMOVE TRANSFORM:
version = "TEST"
language = "hebrew"
category = "animals" 
word = "סיח"
amariltb.functions.remove_transform(word,language,category,version)

# DELETE FROM INDEX:
version = "TEST"
language = "hebrew"
category = "animals" 
word = "סוס"
amariltb.functions.delete_from_index(word,language,category,version)

# GET PRODUCT WORDS BY CATEGORY:
version = "TEST"
language = "hebrew"
category = "animals" 
target_filename = "/yourPathToTheRelevantDirectory/testing_product_words.xlsx"
amariltb.functions.get_product_words_by_category(category,language,target_filename,version)


# DELETE PRODUCT WORDS BY filename:
version = "TEST"
filename = "/yourPathToTheRelevantDirectory/testing_delete_product_words.xlsx"
amariltb.functions.delete_product_words(filename,version)

Conda environments:

if you dont want to polute your main python environment with the amariltb package dependencies , you can opt to use conda envirounments. a cheat sheet for handling envirounments: https://docs.conda.io/projects/conda/en/4.6.0/_downloads/52a95608c49671267e40c689e0bc00ca/conda-cheatsheet.pdf