Git Product home page Git Product logo

fds-tools's Introduction

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 [email protected]

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 [email protected]

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

fds-tools's People

Contributors

dmontaner avatar

Stargazers

Roman avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.