FDS-TOOLS

The library implements some utility functions to quickly set up and run small Data Science projects.

Implemented tools

• fds-conf-setup : helps with the set up apter installing fds-tools using pip.

• fds-conf-show : shows current (full) configuration of fds-tools.

• fds-conf-version : shows fds-tools version. Also the python and R interpreters and versions.

• fds-create-job : create a new job directory structure.

• fds-touch-data-dir : create a new data directory.

• fds-touch-code-dir : create a new code directory.

• fds-touch-job-conf : create a new .job.config file.

• fds-execute-script: execute script of the data analysis pipeline (currently implemented for R, Python, Bash and Impala).

• fds-job-execute : executes all jobs in the pipeline.

• fds-job-log : revises all available log files. Use this to make sure that all where correctly executed.

• fds-job-stats : revises all available log files and derives some execution statistics such as time and precedence checks.

• fds-new-script : creates a new script from the templates repository (available templates for R, Python, Bash and SQL-Impala).

Install

Best way to install fds-tools is using pip:

pip install git+https://github.com/dmontaner/fds-tools

but you can also clone the repository and then:

cd fds-tools
pip3 install .

Set up

The firs time after pip installation you will need to configure the global settings of the tool. You need to provide your email (or any other user name you want to use to sign up your scripts) for this In the shell terminal execute:

fds-config-setup -e your.emails@here.com

Configuration

Global configuration of fds-tools is kept in you home hidden directory ~/.fds-tools/.

• The text file ~/.fds-tools/confg contains all global settings for your projects. It is originally created by fds-config-setup but you can edit it afterwards. fds-config-setup will not overwrite the config file if it already exists.

• The folder ~/.fds-tools/templates contains all script templates. It is originally created by fds-config-setup but you can edit all templates and adapt them for yourself. fds-config-setup will not overwrite the templates if they already exist.

Update

Update using pip directly from the git repository:

pip install -U git+https://github.com/dmontaner/fds-tools

Update using pip from your (HTTP) local clone of the repository:

cd fds-tools
git pull origin master
pip3 install -U .

To update your templates:

rm -r ~/.fds-tools/templates
fds-config-setup -e your.emails@here.com

Dependencies

fds-tools is implemented in:

• python: most of the tools.
• bash : currently just fds-execute-script, fds-job-execute and fds-job-log are bash scripts.

Python libraries required are:

• os
• sys
• shutil
• datetime
• argparse
• configparser
• tabulate