Python SDK and CLI for the Renku platform.
Project description
A Python library for the Renku collaborative data science platform. It allows the user to create projects, manage datasets, and capture data provenance while performing analysis tasks.
- NOTE:
renku-python is the python library for Renku that provides an SDK and a command-line interface (CLI). It does not start the Renku platform itself - for that, refer to the Renku docs on running the platform.
Installation
The latest release is available on PyPI and can be installed using pip:
$ pip install renku
The latest code can be installed directly from the Git repository:
$ pip install -e git+https://github.com/SwissDataScienceCenter/renku-python.git#egg=renku
Usage
Initialize a renku project:
$ mkdir -p ~/temp/my-renku-project $ cd ~/temp/my-renku-project $ renku init
Create a dataset and add data to it:
$ renku dataset create my-dataset $ renku dataset add my-dataset https://raw.githubusercontent.com/SwissDataScienceCenter/renku-python/master/README.rst
Run an analysis:
$ renku run wc < data/my-dataset/README.rst > wc_readme
Trace the data provenance:
$ renku log wc_readme
These are the basics, but there is much more that Renku allows you to do with your data analysis workflows. The full documentation will soon be available at: https://renku-python.readthedocs.io/
Changes
Version 0.1.0 (released TBD)
Initial public release.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for renku-0.1.0.dev20180621-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 759123956ba9513b7194d3a085486c6acc89ea0d837e0ba603f0ac4f41d24119 |
|
MD5 | 4c704a3b3f3d961ec5fb9949a18f5f46 |
|
BLAKE2b-256 | 119ddaa91de798e10085f64d09f4c048dd5a8e03875a951c342b9ac92114fa4a |