Skip to content

Commit

Permalink
Fix review suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
Chuhaa committed Aug 9, 2021
1 parent 8dfc926 commit 3e16c3f
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,22 @@ Ballerina Microsoft Excel Connector
[![GitHub Last Commit](https://img.shields.io/github/last-commit/ballerina-platform/module-ballerinax-microsoft.excel.svg)](https://github.com/ballerina-platform/module-ballerinax-microsoft.excel/commits/master)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

The `microsoft.excel` is a [Ballerina](https://ballerina.io/) connector for Microsoft Excel.
[Microsoft Excel](https://www.microsoft.com/en-ww/microsoft-365/excel) is a spreadsheet application developed by Microsoft in Microsoft Office 365.

[Microsoft Excel](https://www.microsoft.com/en-ww/microsoft-365/excel) is a spreadsheet application developed by Microsoft in the Office365.

This connector provides operations for connecting and interacting with Microsoft Graph API Excel endpoints over the network.
This connector provides operations for connecting and interacting with Microsoft Graph API Excel endpoints over the network.
For more information about configuration and operations, go to the module.
- [`microsoft.excel`](excel/Module.md) - Perform CRUD operations in Microsoft Excel worksheet table, and chart.

# Building from the source
## Setting up the prerequisites
## Building from the source
### Setting up the prerequisites

1. Download and install Java SE Development Kit (JDK) version 11. You can install either [OpenJDK](https://adoptopenjdk.net/) or [Oracle JDK](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html).

> **Note:** Set the JAVA_HOME environment variable to the path name of the directory into which you installed JDK.
2. Download and install [Ballerina Beta 2](https://ballerina.io/).

## Building the source
### Building the source
Execute the commands below to build from the source after installing Ballerina SL Beta2 version.

1. To build the package:
Expand All @@ -33,15 +31,15 @@ Execute the commands below to build from the source after installing Ballerina S
```
bal build -c --skip-tests ./excel
```
# Contributing to Ballerina
## Contributing to Ballerina
As an open source project, Ballerina welcomes contributions from the community.
For more information, go to the [contribution guidelines](https://github.com/ballerina-platform/ballerina-lang/blob/main/CONTRIBUTING.md).
# Code of conduct
## Code of conduct
All contributors are encouraged to read the [Ballerina Code of Conduct](https://ballerina.io/code-of-conduct).
# Useful links
## Useful links
* Discuss about code changes of the Ballerina project in [[email protected]](mailto:[email protected]).
* Chat live with us via our [Slack channel](https://ballerina.io/community/slack/).
* Post all technical questions on Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag.
8 changes: 5 additions & 3 deletions excel/Module.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
## Overview
Ballerina connector for Microsoft Excel is connecting the Microsoft Graph Excel API via Ballerina language. It provides capability to perform CRUD (Create, Read, Update, and Delete) operations on [Excel workbooks](https://docs.microsoft.com/en-us/graph/api/resources/excel?view=graph-rest-1.0) stored in Microsoft OneDrive.

Ballerina connector for Microsoft Excel connects the Microsoft Graph Excel API via [Ballerina](https://ballerina.io/). It provides the capability to perform CRUD (Create, Read, Update, and Delete) operations on [Excel workbooks](https://docs.microsoft.com/en-us/graph/api/resources/excel?view=graph-rest-1.0) stored in a Microsoft OneDrive.

This module supports [Microsoft Graph API](https://docs.microsoft.com/en-us/graph/overview) v1.0 version and only allows to perform functions behalf of the currently logged in user.

## Prerequisites
Before using this connector in your Ballerina application, complete the following:
1. Create a [Microsoft Office365 account](https://signup.live.com/)
2. Obtain token - Follow the steps [here](https://docs.microsoft.com/en-us/graph/auth-v2-user#authentication-and-authorization-steps)
2. Obtain tokens
Follow the steps [here](https://docs.microsoft.com/en-us/graph/auth-v2-user#authentication-and-authorization-steps)

## Quickstart
To use the Microsoft Excel connector in your Ballerina application, update the .bal file as follows:
Expand All @@ -17,7 +19,7 @@ Import the `ballerinax/microsoft.excel` module into the Ballerina project.
import ballerinax/microsoft.excel;
```
### Step 2: Create a new connector instance
Create a `excel:Configuration` with the OAuth2 tokens obtained, and initialize the connector with it.
Create an `excel:Configuration` with the OAuth2 tokens obtained and initialize the connector with it.
```ballerina
excel:Configuration configuration = {
clientConfig: {
Expand Down

0 comments on commit 3e16c3f

Please sign in to comment.