Skip to content
Snippets Groups Projects
Commit 1bc5b600 authored by Dennis Ahrens's avatar Dennis Ahrens
Browse files

[TASK] Updated README

parent a493ba81
No related branches found
No related tags found
No related merge requests found
###############################################################################
# About hshetl
###############################################################################
hshetl is a cli tool for extract transform load data between different sources.
Currently supported sources are files, ldap, oracle and mysql.
Currently supported sources are
- files
- ldap
- oracle
- mysql
###############################################################################
# Install on Debian
###############################################################################
Install the tool by using the setup.py script. It resolves all dependencies. Currently the setup was only tested
on debian based linux distributions.
Install the tool by using the setup.py script. It resolves all dependencies.
Currently the setup was only tested on debian based linux distributions.
You will need to following packages for the building process:
- python-dev
......@@ -18,7 +26,8 @@ You will need to following packages for the building process:
- libssl-dev
- mercurial
sudo apt-get install python-dev python-setuptools libmysqlclient-dev libldap2-dev libsasl2-dev libssl-dev mercurial
sudo apt-get install python-dev python-setuptools libmysqlclient-dev \
libldap2-dev libsasl2-dev libssl-dev mercurial
You also need to run pip install -U distribute, because we need a higher
version of it.
......@@ -43,3 +52,33 @@ deactivate
###############################################################################
We used nosetests to run the included unittests. Install it and run nosetests
from inside the package directory ./hshetl
If you want to run the tests from within your IDE, configure it to use nose
as the test runner. We have tested this with Eclipse and PyDEV IDE.
###############################################################################
# Usage
###############################################################################
usage: hshetl [-h] [-p path] [config]
A tool that hustles data.
positional arguments:
config The path to the configuration file. An absolute path
is taken as it is. Relative paths are relative to the
config directory A relative path starting with . is
relative to your working directory (default:
config.yml)
optional arguments:
-h, --help show this help message and exit
-p path, --path path The path where config files are expected. Note that
this is only respected when the config does *not*
start with / or . (default: /home/username/.hshetl/)
The tool completely depends on a YAML formatted configuration file. Above
you can see how to specify the place of the config file.
If you install the tool on your computer a sample configguration file is
placed inside /home/username/.hshetl/config.yml.sample
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment