Merge branch 'dev' into feat/request-context

Author: samwelkanda

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @samwelkanda @jobala @ddyett @MichaelMainer @shemogumbe

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,36 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: samwelkanda
+
+---
+
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,19 @@
+## Overview
+
+Brief description of what this PR does, and why it is needed.
+
+### Demo
+
+Optional. Screenshots, `curl` examples, etc.
+
+### Notes
+
+Optional. Ancillary topics, caveats, alternative strategies that didn't work out, anything else.
+
+## Testing Instructions
+
+* How to test this PR
+* Prefer bulleted description
+* Start after checking out this branch
+* Include any setup required, such as bundling scripts, restarting services, etc.
+* Include test case, and expected output

msgraphcore/client_factory.py

@@ -11,9 +11,23 @@
 
 
 class HTTPClientFactory:
-    """
-    Constructs HTTP Client(session) instances configured with either custom or default
+    """Constructs native HTTP Client(session) instances configured with either custom or default
     pipeline of middleware.
+
+    :func: Class constructor accepts a user provided session object and kwargs to configure the
+        request handling behaviour of the client
+    :keyword enum api_version: The Microsoft Graph API version to be used, for example
+        `APIVersion.v1` (default). This value is used in setting the base url for all requests for
+        that session.
+        :class:`~msgraphcore.enums.APIVersion` defines valid API versions.
+    :keyword enum cloud: a supported Microsoft Graph cloud endpoint.
+        Defaults to `NationalClouds.Global`
+        :class:`~msgraphcore.enums.NationalClouds` defines supported sovereign clouds.
+    :keyword tuple timeout: Default connection and read timeout values for all session requests.
+        Specify a tuple in the form of Tuple(connect_timeout, read_timeout) if you would like to set
+        the values separately. If you specify a single value for the timeout, the timeout value will
+        be applied to both the connect and the read timeouts.
+    :keyword obj session: A custom Session instance from the python requests library
     """
     def __init__(self, **kwargs):
         """Class constructor that accepts a user provided session object and kwargs
@@ -27,15 +41,24 @@ def __init__(self, **kwargs):
         self._set_default_timeout()
 
     def create_with_default_middleware(self, credential: TokenCredential, **kwargs) -> Session:
-        """Applies the default middleware chain to the HTTP Client"""
+        """Applies the default middleware chain to the HTTP Client
+
+        :param credential: TokenCredential used to acquire an access token for the Microsoft
+            Graph API. Created through one of the credential classes from `azure.identity`
+        """
         middleware = [
             AuthorizationHandler(credential, **kwargs),
         ]
         self._register(middleware)
         return self.session
 
     def create_with_custom_middleware(self, middleware: [BaseMiddleware]) -> Session:
-        """Applies a custom middleware chain to the HTTP Client """
+        """Applies a custom middleware chain to the HTTP Client
+
+        :param list middleware: Custom middleware(HTTPAdapter) list that will be used to create
+            a middleware pipeline. The middleware should be arranged in the order in which they will
+            modify the request.
+        """
         if not middleware:
             raise ValueError("Please provide a list of custom middleware")
         self._register(middleware)

msgraphcore/graph_client.py

@@ -31,7 +31,26 @@ def wrapper(*args, **kwargs):
 
 
 class GraphClient:
-    """Constructs a custom HTTPClient to be used for requests against Microsoft Graph"""
+    """Constructs a custom HTTPClient to be used for requests against Microsoft Graph
+
+    :keyword credential: TokenCredential used to acquire an access token for the Microsoft
+        Graph API. Created through one of the credential classes from `azure.identity`
+    :keyword list middleware: Custom middleware(HTTPAdapter) list that will be used to create
+        a middleware pipeline. The middleware should be arranged in the order in which they will
+        modify the request.
+    :keyword enum api_version: The Microsoft Graph API version to be used, for example
+        `APIVersion.v1` (default). This value is used in setting the base url for all requests for
+        that session.
+        :class:`~msgraphcore.enums.APIVersion` defines valid API versions.
+    :keyword enum cloud: a supported Microsoft Graph cloud endpoint.
+        Defaults to `NationalClouds.Global`
+        :class:`~msgraphcore.enums.NationalClouds` defines supported sovereign clouds.
+    :keyword tuple timeout: Default connection and read timeout values for all session requests.
+        Specify a tuple in the form of Tuple(connect_timeout, read_timeout) if you would like to set
+        the values separately. If you specify a single value for the timeout, the timeout value will
+        be applied to both the connect and the read timeouts.
+    :keyword obj session: A custom Session instance from the python requests library
+    """
     __instance = None
 
     def __new__(cls, *args, **kwargs):