Skip to content

Commit

Permalink
Revising README.rst
Browse files Browse the repository at this point in the history
- Added a Tests section in the README to point to the tests folder
- Added a link to GUIDANCE.md for more exposure on how to contribute to
the project
- Added a section for Code of Conduct
- Made other minor additions/revisions
  • Loading branch information
ro-joowan committed Aug 2, 2017
1 parent 840274c commit 78a0e74
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 10 deletions.
2 changes: 1 addition & 1 deletion GUIDANCE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Links / guidance for Data Lake Python SDKs
# Links and Guidance for Azure Data Lake Python SDKs

_Last updated: 7/8/2016_

Expand Down
52 changes: 43 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
azure-datalake-store
====================
Microsoft Azure Data Lake Store Filesystem Library for Python
=============================================================

.. image:: https://travis-ci.org/Azure/azure-data-lake-store-python.svg?branch=dev
:target: https://travis-ci.org/Azure/azure-data-lake-store-python
.. image:: https://coveralls.io/repos/github/Azure/azure-data-lake-store-python/badge.svg?branch=master
:target: https://coveralls.io/github/Azure/azure-data-lake-store-python?branch=master

azure-datalake-store is a file-system management system in python for the
Azure Data-Lake Store.
This project is the Python filesystem library for Azure Data Lake Store.

INSTALLATION
============

To install from source instead of pip (for local testing and development):

Expand All @@ -16,9 +18,8 @@ To install from source instead of pip (for local testing and development):
> pip install -r dev_requirements.txt
> python setup.py develop
To run tests, you are required to set the following environment variables:
azure_tenant_id, azure_username, azure_password, azure_data_lake_store_name
Usage: Sample Code
==================

To play with the code, here is a starting point:

Expand Down Expand Up @@ -84,8 +85,9 @@ This will output a progress bar to the stdout:
Finished[#############################################################] 100.0000%
```

Command Line Sample Usage
-------------------------
Usage: Command Line Sample
==========================

To interact with the API at a higher-level, you can use the provided
command-line interface in "samples/cli.py". You will need to set
the appropriate environment variables as described above to connect to the
Expand Down Expand Up @@ -181,3 +183,35 @@ Also, downloading a remote file:
2016-08-04 18:57:49,726 - ADLFS - DEBUG - Downloaded to xyz.csv, byte offset 0
2016-08-04 18:57:49,734 - ADLFS - DEBUG - File downloaded (xyz.csv -> xyz.csv)
>
Tests
=====

For detailed documentation about our test framework, please visit the
`tests folder <https://github.com/Azure/azure-sdk-for-python/issues/440>`__.

Need Help?
==========

Be sure to check out the Microsoft Azure `Developer Forums on Stack Overflow <http://go.microsoft.com/fwlink/?LinkId=234489>`__
if you have trouble with the provided code. Most questions are tagged `azure and python <https://stackoverflow.com/questions/tagged/azure+python>`__.


Contribute Code or Provide Feedback
===================================

If you would like to become an active contributor to this project please
follow the instructions provided in `Microsoft Azure Projects Contribution Guidelines <http://azure.github.io/guidelines/>`__.
Furthermore, check out `GUIDANCE.md <https://github.com/Azure/azure-data-lake-store-python/blob/master/GUIDANCE.md>`__
for specific information related to this project.

If you encounter any bugs with the library please file an issue in the
`Issues <https://github.com/Azure/azure-data-lake-store-python/issues>`__
section of the project.


Code of Conduct
===============
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact
[opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

0 comments on commit 78a0e74

Please sign in to comment.