/pipebook

Next-generation notebook for resilient, production-ready data pipelines

Primary LanguagePythonMIT LicenseMIT

pipebook

Next-generation notebook for resilient, production-ready data pipelines

A graphical user interface based on The Data Config design pattern, using the FRIDAAY data format.

See the introductory PipeBook blog post.

Usage

Use [poetry](https://python-poetry.org/docs/) to manage both dependencies and the virtual environment:

Installing Poetry

$ curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
# WINDOWS: (Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python -

Running PipeBook from Git

$ git clone https://github.com/TheSwanFactory/pipebook.git
$ cd pipebook
$ poetry install # OR: '$ poetry update'
$ poetry run python -m pipebook

Development

$ poetry env use python
$ poetry run pytest
$ poetry run ptw

Releases

$ poetry update
$ poetry version patch
$ poetry build && poetry publish
$ poetry version prepatch

Implementation

Uses the Toga GUI Toolkit for Python. For more details, see the PipeBook UX Design Brief.