diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index cb2cdd3..df6232e 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,5 +1,2 @@ -# These are supported funding model platforms - github: [areed1192] -patreon: sigmacoding -custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] +patreon: sigmacoding \ No newline at end of file diff --git a/ms_graph/client.py b/ms_graph/client.py index a8b227f..1e8d1da 100644 --- a/ms_graph/client.py +++ b/ms_graph/client.py @@ -306,7 +306,7 @@ def grab_access_token(self) -> Dict: ### Returns: ---- - Dict: A dictionary containing a new access token and refresh token. + dict : A dictionary containing a new access token and refresh token. """ # Parse the Code. @@ -330,7 +330,7 @@ def grab_refresh_token(self) -> Dict: ### Returns ---- - Dict: + dict : A token dictionary with a new access token. """ diff --git a/ms_graph/drive_items.py b/ms_graph/drive_items.py index 76dc263..35228b2 100644 --- a/ms_graph/drive_items.py +++ b/ms_graph/drive_items.py @@ -42,7 +42,7 @@ def get_drive_item(self, drive_id: str, item_id: str) -> dict: ### Returns ---- - dict: + dict : A DriveItem resource object. """ @@ -66,7 +66,7 @@ def get_drive_item_by_path(self, drive_id: str, item_path: str) -> dict: ### Returns ---- - dict: + dict : A DriveItem resource object. """ @@ -91,7 +91,7 @@ def get_group_drive_item(self, group_id: str, item_id: str) -> dict: ### Returns ---- - dict: + dict : A DriveItem resource object. """ @@ -115,7 +115,7 @@ def get_group_drive_item_by_path(self, group_id: str, item_path: str) -> dict: ### Returns ---- - dict: + dict : A DriveItem resource object. """ @@ -137,7 +137,7 @@ def get_my_drive_item(self, item_id: str) -> dict: ### Returns ---- - dict: + dict : A DriveItem resource object. """ @@ -158,7 +158,7 @@ def get_my_drive_item_by_path(self, item_path: str) -> dict: ### Returns ---- - dict: + dict : A DriveItem resource object. """ @@ -183,7 +183,7 @@ def get_site_drive_item(self, site_id: str, item_id: str) -> dict: ### Returns ---- - dict: + dict : A DriveItem resource object. """ @@ -207,7 +207,7 @@ def get_site_drive_item_by_path(self, site_id: str, item_path: str) -> dict: ### Returns ---- - dict: + dict : A DriveItem resource object. """ @@ -235,7 +235,7 @@ def get_site_drive_item_from_list(self, site_id: str, list_id: str, item_id: str ### Returns ---- - dict: + dict : A DriveItem resource object. """ @@ -260,7 +260,7 @@ def get_user_drive_item(self, user_id: str, item_id: str) -> dict: ### Returns ---- - dict: + dict : A DriveItem resource object. """ @@ -284,7 +284,7 @@ def get_user_drive_item_by_path(self, user_id: str, item_path: str) -> dict: ### Returns ---- - dict: + dict : A DriveItem resource object. """ diff --git a/ms_graph/drives.py b/ms_graph/drives.py index 1741d21..4e15aa8 100644 --- a/ms_graph/drives.py +++ b/ms_graph/drives.py @@ -33,7 +33,7 @@ def get_root_drive(self) -> dict: ### Returns ---- - dict: + dict : A Drive Resource Object. """ @@ -49,7 +49,7 @@ def get_root_drive_children(self) -> dict: ### Returns ---- - dict: + dict : A List of Drive Resource Object. """ @@ -65,7 +65,7 @@ def get_root_drive_delta(self) -> dict: ### Returns ---- - dict: + dict : A List of Drive Resource Object. """ @@ -81,7 +81,7 @@ def get_root_drive_followed(self) -> dict: ### Returns ---- - dict: + dict : A List of DriveItem Resource Object. """ @@ -102,7 +102,7 @@ def get_recent_files(self) -> dict: ### Returns ---- - dict: + dict : A List of DriveItem Resource Objects. """ @@ -119,7 +119,7 @@ def get_shared_files(self) -> dict: ### Returns ---- - dict: + dict : A List of DriveItem Resource Objects. """ @@ -147,7 +147,7 @@ def get_special_folder_by_name(self, folder_name: str) -> dict: ### Returns ---- - dict: + dict : A List of DriveItem Resource Objects. """ @@ -164,7 +164,7 @@ def get_special_folder_children_by_name(self, folder_name: str) -> dict: ### Returns ---- - dict: + dict : A List of DriveItem Resource Objects. """ @@ -180,7 +180,7 @@ def get_drive_by_id(self, drive_id: str) -> dict: ### Returns ---- - dict: + dict : A Drive Resource Object. """ @@ -196,7 +196,7 @@ def get_my_drive(self) -> dict: ### Returns ---- - dict: + dict : A Drive Resource Object. """ @@ -212,7 +212,7 @@ def get_my_drive_children(self, item_id: str) -> dict: ### Returns ---- - dict: + dict : A List of DriveChildren Resource Objects. """ @@ -228,7 +228,7 @@ def get_my_drives(self) -> dict: ### Returns ---- - dict: + dict : A List of Drive Resource Objects. """ @@ -244,7 +244,7 @@ def get_user_drive(self, user_id: str) -> dict: ### Returns ---- - dict: + dict : A Drive Resource Object. """ @@ -260,7 +260,7 @@ def get_user_drive_children(self, user_id: str, item_id: str) -> dict: ### Returns ---- - dict: + dict : A List of DriveChildren Resource Objects. """ @@ -276,7 +276,7 @@ def get_user_drives(self, user_id: str) -> dict: ### Returns ---- - dict: + dict : A List of Drive Resource Objects. """ @@ -292,7 +292,7 @@ def get_group_drive(self, group_id: str) -> dict: ### Returns ---- - dict: + dict : A Drive Resource Object. """ @@ -308,7 +308,7 @@ def get_group_drive_children(self, group_id: str, item_id: str) -> dict: ### Returns ---- - dict: + dict : A List of DriveChildren Resource Objects. """ @@ -324,7 +324,7 @@ def get_group_drives(self, group_id: str) -> dict: ### Returns ---- - dict: + dict : A List of Drive Resource Objects. """ @@ -340,7 +340,7 @@ def get_sites_drive(self, site_id: str) -> dict: ### Returns ---- - dict: + dict : A Drive Resource Object. """ @@ -356,7 +356,7 @@ def get_sites_drive_children(self, site_id: str, item_id: str) -> dict: ### Returns ---- - dict: + dict : A List of DriveChildren Resource Objects. """ @@ -372,7 +372,7 @@ def get_sites_drives(self, site_id: str) -> dict: ### Returns ---- - dict: + dict : A List of Drive Resource Objects. """ diff --git a/ms_graph/notes.py b/ms_graph/notes.py index d5f9b53..43f912c 100644 --- a/ms_graph/notes.py +++ b/ms_graph/notes.py @@ -33,7 +33,7 @@ def list_my_notebooks(self) -> dict: ### Returns ---- - dict: + dict : A List of `Notebook` Resource Object. """ @@ -57,7 +57,7 @@ def list_user_notebooks(self, user_id: str) -> dict: ### Returns ---- - dict: + dict : A List of `Notebook` Resource Object. """ @@ -81,7 +81,7 @@ def list_group_notebooks(self, group_id: str) -> dict: ### Returns ---- - dict: + dict : A List of `Notebook` Resource Object. """ @@ -105,7 +105,7 @@ def list_site_notebooks(self, site_id: str) -> dict: ### Returns ---- - dict: + dict : A List of `Notebook` Resource Object. """ @@ -129,7 +129,7 @@ def get_my_notebook(self, notebook_id: str) -> dict: ### Returns ---- - dict: + dict : A List of `Notebook` Resource Object. """ @@ -156,7 +156,7 @@ def get_user_notebook(self, user_id: str, notebook_id: str) -> dict: ### Returns ---- - dict: + dict : A List of `Notebook` Resource Object. """ @@ -183,7 +183,7 @@ def get_group_notebook(self, group_id: str, notebook_id: str) -> dict: ### Returns ---- - dict: + dict : A List of `Notebook` Resource Object. """ @@ -210,7 +210,7 @@ def get_site_notebook(self, site_id: str, notebook_id: str) -> dict: ### Returns ---- - dict: + dict : A List of `Notebook` Resource Object. """ @@ -234,7 +234,7 @@ def list_my_notebook_sections(self, notebook_id: str) -> dict: ### Returns ---- - dict: + dict : A List of `Notebook` Resource Object. """ @@ -261,7 +261,7 @@ def list_my_notebook_pages(self, section_id: str) -> dict: ### Returns ---- - dict: + dict : A List of `Notebook` Resource Object. """ diff --git a/ms_graph/personal_contacts.py b/ms_graph/personal_contacts.py index ccc65eb..a0640e5 100644 --- a/ms_graph/personal_contacts.py +++ b/ms_graph/personal_contacts.py @@ -32,7 +32,7 @@ def list_my_contacts(self) -> dict: ### Returns ---- - dict: + dict : A List of `Contact` Resource Object. """ @@ -51,7 +51,7 @@ def list_my_contacts_folder(self) -> dict: ### Returns ---- - dict: + dict : A List of `ContactFolders` Resource Object. """ @@ -78,7 +78,7 @@ def list_contacts_folder_by_id(self, user_id: str, folder_id: str) -> dict: ### Returns ---- - dict: + dict : A List of `ContactFolders` Resource Object. """ @@ -104,7 +104,7 @@ def create_my_contact_folder(self, folder_resource: dict) -> dict: ### Returns ---- - dict: + dict : A `ContactFolder` Resource Object. """ @@ -134,7 +134,7 @@ def create_user_contact_folder(self, user_id: str, folder_resource: dict) -> dic ### Returns ---- - dict: + dict : A `ContactFolder` Resource Object. """ @@ -159,7 +159,7 @@ def get_my_contacts_folder_by_id(self, folder_id: str) -> dict: ### Returns ---- - dict: + dict : A `ContactFolder` Resource Object. """ @@ -187,7 +187,7 @@ def get_contacts_folder_by_id(self, user_id: str, folder_id: str) -> dict: ### Returns ---- - dict: + dict : A `ContactFolder` Resource Object. """ @@ -211,7 +211,7 @@ def get_my_contact_by_id(self, contact_id: str) -> dict: ### Returns ---- - dict: + dict : A List of `Contact` Resource Object. """ diff --git a/ms_graph/search.py b/ms_graph/search.py index dceadd0..e8f8d1d 100644 --- a/ms_graph/search.py +++ b/ms_graph/search.py @@ -32,7 +32,7 @@ def query(self, search_request: dict) -> dict: ### Returns ---- - dict: + dict : A `SearchResponse` collection. """ diff --git a/ms_graph/session.py b/ms_graph/session.py index 7feb5c5..7979c16 100644 --- a/ms_graph/session.py +++ b/ms_graph/session.py @@ -58,7 +58,7 @@ def build_headers(self, additional_args: dict = None) -> Dict: ### Returns ---- - Dict: + dict : A dictionary containing all the components. """ diff --git a/setup.py b/setup.py index 4b32c79..eae2f4a 100644 --- a/setup.py +++ b/setup.py @@ -2,70 +2,19 @@ from setuptools import find_namespace_packages # Open the README file. -with open(file="README.md", mode="r", encoding='utf-8') as fh: +with open(file="README.md", mode="r", encoding="utf-8") as fh: long_description = fh.read() setup( - - name='ms-graph-python-client', - - # Define Author Info. - author='Alex Reed', - author_email='coding.sigma@gmail.com', - - # Define Version Info. - version='0.1.0', - - # Define descriptions. - description='A Python Client Application that allows interaction with the Microsoft Graph API.', + name="ms-graph-python-client", + author="Alex Reed", + author_email="coding.sigma@gmail.com", + version="0.1.0", + description="A Python Client Application that allows interaction with the Microsoft Graph API.", long_description=long_description, long_description_content_type="text/markdown", - - # Define repo location. - url='https://github.com/areed1192/ms-graph-python-client', - - # Define dependencies. - install_requires=[ - 'requests', - 'msal' - ], - - # Specify folder content. - packages=find_namespace_packages( - include=['ms_graph', 'ms_graph.*'] - ), - - # Define the python version. - python_requires='>3.8', - - # Define our classifiers. - classifiers=[ - - # Phase of development my library is in. - 'Development Status :: 3 - Alpha', - - # Audience this library is intended for. - 'Intended Audience :: Developers', - 'Intended Audience :: Science/Research', - 'Intended Audience :: Financial and Insurance Industry', - - # License that guides my library. - 'License :: OSI Approved :: MIT License', - - # Package was written in English. - 'Natural Language :: English', - - # Operating systems. - 'Operating System :: OS Independent', - - # Programming Languages Used.. - 'Programming Language :: Python :: 3.7', - 'Programming Language :: Python :: 3.8', - - # Topics. - 'Topic :: Database', - 'Topic :: Education', - 'Topic :: Office/Business' - ] - + url="https://github.com/areed1192/ms-graph-python-client", + install_requires=["requests", "msal"], + packages=find_namespace_packages(include=["ms_graph", "ms_graph.*"]), + python_requires=">3.8", )