https://github.com/portfoliome/foil

Utilities for data cleaning and ETL processing
https://github.com/portfoliome/foil

data-acquisition etl finance python-3 utilities

Last synced: about 2 months ago
JSON representation

Utilities for data cleaning and ETL processing

• Host: GitHub
• URL: https://github.com/portfoliome/foil
• Owner: portfoliome
• License: mit
• Created: 2016-10-02T22:06:53.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-12-14T18:25:56.000Z (about 7 years ago)
• Last Synced: 2024-10-12T05:46:16.023Z (3 months ago)
• Topics: data-acquisition, etl, finance, python-3, utilities
• Language: Python
• Size: 66.4 KB
• Stars: 24
• Watchers: 13
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/portfoliome/foil.svg?branch=master)](https://travis-ci.com/portfoliome/foil)

[![codecov.io](http://codecov.io/github/portfoliome/foil/coverage.svg?branch=master)](http://codecov.io/github/portfoliome/foil?branch=master)

[![Code Climate](https://codeclimate.com/github/portfoliome/foil/badges/gpa.svg)](https://codeclimate.com/github/portfoliome/foil)

[![Code Health](https://landscape.io/github/portfoliome/foil/master/landscape.svg?style=flat)](https://landscape.io/github/portfoliome/foil/master)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/portfoliome/foil/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/portfoliome/foil/?branch=master)

# foil

foil contains for data cleaning and ETL processing.

## Design Conventions

* Use iterators and generators to build data processing pipelines.

* eliminate **IF** statements

* descriptive variable names

* reliance on the standard library

* priority for test driven development

Contributions are welcome. 

### Getting Started

These instructions assume Python 3.5. It is recommended that you use conda or a virtualenv. foil is fairly lightweight, but has some dependencies.

#### For conda install follow:

Download the [conda installer](http://conda.pydata.org/miniconda.html).

And follow setup [instructions](http://conda.pydata.org/docs/install/quick.html#id1).

#### Conda Environment

```sh

conda create --name  python=3.5

activate 

conda install --file requirements.txt

python setup.py install bdist_wheel

```

#### debian installation

[Instruction](https://linuxconfig.org/how-to-change-from-default-to-alternative-python-version-on-debian-linux)

Follow the instructions in the link provided. **DO NOT SUDO PIP INSTALL**. Alias the preferred Python installation by adding, for example:

```sh

alias python='/usr/bin/python3.5'

```

#### When using Pip

```sh

pip install --upgrade pip

pip install wheel

pip install -r requirements.txt

python setup.py install bdist_wheel

```

#### Running the Tests

```sh

py.test

```

#### Running Coverage Report

```sh

py.test --cov

```