diff --git a/README.md b/README.md index 41b37e7..2cb7340 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Azure Data Service Notebook (Beta) +# Azure Data Service Notebook (Alpha) Azure Data Service Notebook is a set of extentions for working with Azure Data Service (e.g. Azure Data Lake, HDIsight, CosmosDB, Azure SQL and Azure Data Warehouse etc.) using Jupyter Notebook. -**WARNING**: This SDK/CLI is currently in **Beta Preview** stage. It can and will change in backwards incompatible ways. +**WARNING**: This SDK/CLI is currently in very early stage of development. It can and will change in backwards incompatible ways. # Feature diff --git a/adlmagics/README.md b/adlmagics/README.md index 52585bc..2cb7340 100644 --- a/adlmagics/README.md +++ b/adlmagics/README.md @@ -1,19 +1,21 @@ -# Azure Data Service Notebook -Azure Data Service Notebook is a set of tool for working with Azure Data Service (including HDInsight, Azure Data Lake, etc) +# Azure Data Service Notebook (Alpha) +Azure Data Service Notebook is a set of extentions for working with Azure Data Service (e.g. Azure Data Lake, HDIsight, CosmosDB, Azure SQL and Azure Data Warehouse etc.) using Jupyter Notebook. + +**WARNING**: This SDK/CLI is currently in very early stage of development. 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. -| Commands | Function | +| Command | Function | |-----|-----| |%adl login |Line magic to log in to Azure Data Lake.| -|%adl listaccounts|Line magic to list the Azure Data Lake analytic accounts for current user.| +|%adl listaccounts|Line magic to list the Azure Data Lake Analytic accounts for current user.| |%adl listjobs|Line magic to list the Azure Data Lake jobs for a given account.| -|%%adl submitjob|Cell magic to submit a USQL job to ADL cluster.| -|%adl viewjob|Line magic to view job info.| -|%adl liststorefile|Line magic to list the Azure Data Lake store accounts.| +|%%adl submitjob|Cell magic to submit a USQL job to Azure Data Lake cluster.| +|%adl viewjob|Line magic to view detailed job info.| +|%adl liststorefile|Line magic to list the Azure Data Lake Store accounts.| |%adl sample|Line magic to sample a given file, return results as Pandas DataFrame.| |%adl logout|Line magic to log out.| @@ -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 and data exploration 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