dask-template

This project aims to be a starting point for Dask related data pipelines.

Dask documentation: http://docs.dask.org/en/latest/

Prerequisites

Install python and virtualenv

Continuous Integration

Check CI status here

How-to

All-in-one: make all
- Setup, format, test and package
Setup: make setup
- Installs all dependencies
Test: make test
- Runs all tests
- Using pytest
Clean: make clean
- Removes all cached files
Format: make checkFormat
- Checks standard style is applied
- Using pylama
- Configure settings on pylama.ini
Package: make package
- Creates a bundle of software to be installed
Docs: make docs
- Generates documentation from modules
- Using pydoc

Note: Run Setup as your init command (or after Clean)

To-Do

Add more Dask methods (+ tests)
Wrap package into Docker image
Support Jupyter notebook

Contributing

Review the contributing guidelines before you make your awesome contribution

License

This project is licensed under the terms of the MIT license. See LICENSE