From 08e1fad0e9ef1721c7023b015c8335bc4e57c63c Mon Sep 17 00:00:00 2001 From: Ruixin Xu Date: Thu, 7 Jun 2018 18:39:13 +0800 Subject: [PATCH] update readme 1. update installation step 2. fix the broken URL of demo file 3. add beta warning 4. add feedback instruction --- README.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 52585bc..76de810 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ -# Azure Data Service Notebook +# Azure Data Service Notebook (Beta) Azure Data Service Notebook is a set of tool for working with Azure Data Service (including HDInsight, Azure Data Lake, etc) +**WARNING**: This SDK/CLI is currently in **Beta Preview** stage. It can and will change in backwards incompatible ways. + # Feature Azure Data Service Notebook currently provides a set of magic commands for users to access Azure Data Lake. Available magics are captured in the table below. @@ -22,21 +24,17 @@ Azure Data Service Notebook currently provides a set of magic commands for users - Download and Install [python 3.6+](https://www.python.org/downloads/) - Install jupyter: `pip install jupyter` -- Install azure packages fully : - `pip install azure` -- Or just install the key packages : - - `pip install adla` - - `pip install azure-mgmt-resource` - - `pip install azure-mgmt-datalake-analytics` - - `pip install azure-mgmt-datalake-store` - - `pip install azure-datalake-store` -- Copy the [adlmagic folder](/analytics_notebook/adlmagics) to local box. +- Install adlmagic extention : + `pip install --no-cache-dir adlmagics` + # Examples -- [adlmagics_demo.ipynb](/analytics_notebook/adlmagics/00_adlmagics_demo.ipynb), demo file of Azure Data Lake job control functions. +- [adlmagics_demo.ipynb](/adlmagics/00_adlmagics_demo.ipynb), demo file of Azure Data Lake job control functions. +# Feedback +- You can submit [bug report](https://github.com/Azure/Azure-Data-Service-Notebook/issues/new?template=bug_report.md) or [feature request](https://github.com/Azure/Azure-Data-Service-Notebook/issues/new?template=feature_request.md) directly in this repo. Our team will triage issues actively. # Contributing