README user guide

Author: Yordy Gelvez

README.md

@@ -1 +1,273 @@
-# microsoftgraph-python
+# microsoft-python
+Microsoft graph API wrapper for Microsoft Graph written in Python.
+
+## Installing
+```
+git+git://github.com/GearPlug/microsoftgraph-python
+```
+
+## Usage
+```
+from microsoftgraph.client import Client
+client = Client('CLIENT_ID', 'CLIENT_SECRET', account_type='by defect common')
+```
+
+#### Get authorization url
+for office 365
+```
+url = client.authorization_url(redirect_uri, scope, state=None, office365=True)
+```
+for microsoft graph
+```
+url = client.authorization_url(redirect_uri, scope, state=None, office365=False)
+```
+
+#### Exchange the code for an access token
+for office 365
+```
+token = client.exchange_code(redirect_uri, code, office365=True)
+```
+for microsoft graph
+```
+token = client.exchange_code(redirect_uri, code, office365=False)
+```
+
+#### Refresh token
+for office 365
+```
+token = client.refresh_token(redirect_uri, refresh_token, office365=True)
+```
+for microsoft graph
+```
+token = client.refresh_token(redirect_uri, refresh_token, office365=False)
+```
+
+#### Set token
+for office 365
+```
+token = client.set_token(token, office365=True)
+```
+for microsoft graph
+```
+token = client.set_token(token, office365=False)
+```
+
+#### Get me
+```
+me = client.get_me()
+```
+
+#### Get message
+```
+me = client.get_message(message_id="")
+```
+
+### Webhook section, see the api documentation: https://developer.microsoft.com/en-us/graph/docs/api-reference/beta/resources/webhooks
+
+#### Create subscription
+```
+subscription = client.create_subscription(change_type, notification_url, resource, expiration_datetime, client_state=None)
+```
+
+#### Renew subscription
+```
+renew = client.renew_subscription(subscription_id, expiration_datetime)
+```
+
+#### Delete subscription
+```
+renew = client.delete_subscription(subscription_id)
+```
+
+### Onenote section, see the api documentation: https://developer.microsoft.com/en-us/graph/docs/concepts/integrate_with_onenote
+
+#### List notebooks
+```
+notebooks = client.list_notebooks()
+```
+
+#### Get notebook
+```
+notebook = client.get_notebook(notebook_id)
+```
+
+#### Get notebook sections
+```
+section_notebook = client.get_notebook_sections(notebook_id)
+```
+
+#### Create page
+```
+add_page = client.create_page(section_id, files)
+```
+
+#### List pages
+```
+pages = client.list_pages()
+```
+
+### Calendar section, see the api documentation: https://developer.microsoft.com/en-us/graph/docs/api-reference/beta/resources/calendar
+
+#### Get events
+```
+events = client.get_me_events()
+```
+
+#### Create calendar event
+```
+events = client.create_calendar_event(subject, content, start_datetime, start_timezone, end_datetime, end_timezone,
+                              recurrence_type, recurrence_interval, recurrence_days_of_week, recurrence_range_type,
+                              recurrence_range_startdate, recurrence_range_enddate, location, attendees, calendar=None)
+```
+
+#### Get calendars
+```
+events = client.get_me_calendars()
+```
+
+#### Create calendar
+```
+events = client.create_calendar(name)
+```
+
+### Contacts section, see the api documentation: https://developer.microsoft.com/en-us/graph/docs/api-reference/beta/resources/contact
+
+#### Get contacts
+If you need a specific contact send the contact id in data_id
+```
+specific_contact = client.outlook_get_me_contacts(data_id="")
+```
+If you want all the contacts
+```
+specific_contact = client.outlook_get_me_contacts()
+```
+
+#### Create contact
+```
+add_contact = client.outlook_create_me_contact()
+```
+
+#### Create contact in specific folder
+```
+add_contact_folder = client.outlook_create_contact_in_folder(folder_id)
+```
+
+#### Get contact folders
+```
+folders = client.outlook_get_contact_folders()
+```
+
+#### Create contact folders
+```
+add_folders = client.outlook_create_contact_folder()
+```
+
+### Onedrive section, see the api documentation: https://developer.microsoft.com/en-us/graph/docs/api-reference/beta/resources/onedrive
+
+#### Get root items
+```
+root_items = client.drive_root_items()
+```
+
+#### Get root children items
+```
+root_children_items = client.drive_root_children_items()
+```
+
+#### Get specific folder items
+```
+folder_items = client.drive_specific_folder(folder_id)
+```
+
+### Excel section, see the api documentation: https://developer.microsoft.com/en-us/graph/docs/api-reference/beta/resources/excel
+For use excel, you should know the folder id where the file is
+#### Create session for specific item
+```
+create_session = client.drive_create_session(item_id)
+```
+
+#### Refresh session for specific item
+```
+refresh_session = client.drive_refresh_session(item_id)
+```
+
+#### Close session for specific item
+```
+close_session = client.drive_close_session(item_id)
+```
+
+#### Get worksheets
+```
+get_worksheets = client.excel_get_worksheets(item_id)
+```
+
+#### Get specific worksheet
+```
+specific_worksheet = client.excel_get_specific_worksheet(item_id, worksheet_id)
+```
+
+#### Add worksheets
+```
+add_worksheet = client.excel_add_worksheet(item_id)
+```
+
+#### Update worksheet
+```
+update_worksheet = client.excel_update_worksheet(item_id, worksheet_id)
+```
+
+#### Get charts
+```
+get_charts = client.excel_get_charts(item_id, worksheet_id)
+```
+
+#### Add chart
+```
+add_chart = client.excel_add_chart(item_id, worksheet_id)
+```
+
+#### Get tables
+```
+get_tables = client.excel_get_tables(item_id)
+```
+
+#### Add table
+```
+add_table = client.excel_add_table(item_id)
+```
+
+#### Add column to table
+```
+add_column = client.excel_add_column(item_id, worksheets_id, table_id)
+```
+
+#### Add row to table
+```
+add_row = client.excel_add_row(item_id, worksheets_id, table_id)
+```
+
+#### Get table rows
+```
+get_rows = client.excel_get_rows(item_id, table_id)
+```
+
+#### Get range
+```
+get_range = client.excel_get_range(item_id, worksheets_id)
+```
+
+#### Update range
+```
+update_range = client.excel_update_range(item_id, worksheets_id)
+```
+
+## Requirements
+- requests
+- base64
+- mimetypes
+- urllib.parse -- urlencode, --quote_plus
+
+## Tests
+```
+test/test.py
+```

microsoftgraph/client.py

@@ -224,6 +224,7 @@ def delete_subscription(self, subscription_id):
         """
         return self._delete('https://graph.microsoft.com/beta/' + 'subscriptions/{}'.format(subscription_id))
 
+    # Onenote
     @token_required
     def list_notebooks(self):
         """Retrieve a list of notebook objects.
@@ -287,6 +288,7 @@ def list_pages(self, params=None):
         """
         return self._get(self.base_url + '/me/onenote/pages', params=params)
 
+    # Calendar
     @token_required
     def get_me_events(self):
         """Get a list of event objects in the user's mailbox. The list contains single instance meetings and
@@ -408,6 +410,7 @@ def get_me_calendars(self):
         """
         return self._get(self.base_url + 'me/calendars')
 
+    # Mail
     @token_required
     def send_mail(self, subject=None, recipients=None, body='', content_type='HTML', attachments=None):
         """Helper to send email from current user.
@@ -451,6 +454,7 @@ def send_mail(self, subject=None, recipients=None, body='', content_type='HTML',
         # Do a POST to Graph's sendMail API and return the response.
         return self._post(self.base_url + 'me/microsoft.graph.sendMail', json=email_msg)
 
+    # Outlook
     @token_required
     def outlook_get_me_contacts(self, data_id=None, params=None):
         if data_id is None:
@@ -479,6 +483,7 @@ def outlook_create_contact_folder(self, **kwargs):
         url = "{0}me/contactFolders".format(self.base_url)
         return self._post(url, **kwargs)
 
+    # Onedrive
     @token_required
     def drive_root_items(self, params=None):
         return self._get('https://graph.microsoft.com/beta/me/drive/root', params=params)
@@ -508,6 +513,7 @@ def drive_close_session(self, item_id, **kwargs):
         url = "https://graph.microsoft.com/beta/me/drive/items/{0}/workbook/closeSession".format(item_id)
         return self._post(url, **kwargs)
 
+    # Excel
     @token_required
     def excel_get_worksheets(self, item_id, params=None, **kwargs):
         url = "https://graph.microsoft.com/beta/me/drive/items/{0}/workbook/worksheets".format(item_id)
@@ -568,15 +574,15 @@ def excel_get_rows(self, item_id, table_id, params=None, **kwargs):
         url = "https://graph.microsoft.com/beta/me/drive/items/{0}/workbook/tables/{1}/rows".format(item_id, table_id)
         return self._get(url, params=params, **kwargs)
 
-    @token_required
-    def excel_get_cell(self, item_id, worksheets_id, params=None, **kwargs):
-        url = "https://graph.microsoft.com/beta/me/drive/items/{0}/workbook/worksheets/{1}/Cell(row='1', column='A')".format(item_id, quote_plus(worksheets_id))
-        return self._get(url, params=params, **kwargs)
+    # @token_required
+    # def excel_get_cell(self, item_id, worksheets_id, params=None, **kwargs):
+    #     url = "https://graph.microsoft.com/beta/me/drive/items/{0}/workbook/worksheets/{1}/Cell(row='1', column='A')".format(item_id, quote_plus(worksheets_id))
+    #     return self._get(url, params=params, **kwargs)
 
-    @token_required
-    def excel_add_cell(self, item_id, worksheets_id, **kwargs):
-        url = "https://graph.microsoft.com/beta/me/drive/items/{0}/workbook/worksheets/{1}/rows".format(item_id, worksheets_id)
-        return self._patch(url, **kwargs)
+    # @token_required
+    # def excel_add_cell(self, item_id, worksheets_id, **kwargs):
+    #     url = "https://graph.microsoft.com/beta/me/drive/items/{0}/workbook/worksheets/{1}/rows".format(item_id, worksheets_id)
+    #     return self._patch(url, **kwargs)
 
     @token_required
     def excel_get_range(self, item_id, worksheets_id, **kwargs):