TeamsGraphApi


NameTeamsGraphApi JSON
Version 0.0.5 PyPI version JSON
download
home_page
Summarywrapper for micorsoft teams graph api's
upload_time2023-07-05 10:11:21
maintainer
docs_urlNone
author
requires_python>=3.8
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
  

# TeamsGraphApi

  

TeamsGraphApi is a wrapper for microsoft graph's RESTful web API that enables you to access microsoft teams for general uses

  

  

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/django) ![Bower](https://img.shields.io/bower/l/graph)

## Installation

  

  

TeamsGraphApi requires [python](https://www.python.org/) 3.6+ to run.

  

  

You can install TeamsGraphApi with all the optional dependencies using pip:

  

```sh

pip  install  TeamsGraphApi

```

  

  

With **TeamsgraphApi** you can only access below Api's

  

  

## Features

  

1.  **get_teams**

2.  **get_channels**

3.  **list_all_members_of_channel**

4.  **get_messages_of_channels**

5.  **get_messages_details_of_channels**

6.  **get_replies_of_a_messages**

  

  

### Usage

  

  

```

  

from graphapi.graph import GraphAPI

  

graph_obj = GraphAPI(Auth_Token)

graph_obj.get_teams()

  

```

  

from the above code we first we import GraphAPI class from graph module

  

after we need to initialize the instance of this class by passing **Authentication token** in it

  

then we can use it's method you can also verify all existing methods using inbuild **dir** method

  

As we listed all the available api's above :

so now we will cover basics of each api's that how we can use them

  
  
  

  
  

-  **get_teams**

> To use this we don't need to pass any extra arguments if you are authenticated user you can simply get all the joined teams using below method.

>  `graph_obj.get_teams()`

  

-  **get_channels**

> Channels are related to a team so if you want to access a channel then you have to pass **team_id** as a arguments eg.

>  `graph_obj.get_channels(team_id)`

  

-  **list_all_members_of_channel**

> listing all members of channel required **team_id** and **channel_id** as a arguments eg.

>  `graph_obj.list_all_members_of_channel(team_id, channel_id)`

  

-  **get_messages_of_channels**

> listing all messages of channel required **team_id** and **channel_id** as a arguments eg.

>  `graph_obj.get_messages_of_channels(team_id, channel_id)`

 **   TeamsGraphapi  supports query params for message Api, in get_messages_of_channels query param will    be the last argument in this method which will be passed in the form of dictionary
 eg.    `graph_obj.get_messages_of_channels(team_id, channel_id,  {"$top": 10 })`
 


  
  

-  **get_messages_details_of_channels**

> To get message details use this method with these **team_id** , **channel_id** , **message_id** arguments

>  `graph_obj.get_messages_details_of_channels(team_id, channel_id, message_id)`

  
  

-  **get_replies_of_a_messages**

> to get replies of message we need a team and a channel where the message reside and when we want replies of a message so we also need a message to get its reply so arguments we now need are **team_id**, **channel_id**, **message_id**   get_replies_of_a_message also works with query params  similar to -   **get_messages_of_channels**  passed  dictionary must be the last argument in the method eg.

>  `graph_obj.get_replies_of_a_messages(team_id, channel_id, message_id)`

  
  

## License

MIT

  

**✨Keep Learning**✨

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "TeamsGraphApi",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "Ajay Vishwakarma <ajay.vishwakarma@codiant.com>",
    "download_url": "",
    "platform": null,
    "description": "\n  \n\n# TeamsGraphApi\n\n  \n\nTeamsGraphApi is a wrapper for microsoft graph's RESTful web API that enables you to access microsoft teams for general uses\n\n  \n\n  \n\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/django) ![Bower](https://img.shields.io/bower/l/graph)\n\n## Installation\n\n  \n\n  \n\nTeamsGraphApi requires [python](https://www.python.org/) 3.6+ to run.\n\n  \n\n  \n\nYou can install TeamsGraphApi with all the optional dependencies using pip:\n\n  \n\n```sh\n\npip  install  TeamsGraphApi\n\n```\n\n  \n\n  \n\nWith **TeamsgraphApi** you can only access below Api's\n\n  \n\n  \n\n## Features\n\n  \n\n1.  **get_teams**\n\n2.  **get_channels**\n\n3.  **list_all_members_of_channel**\n\n4.  **get_messages_of_channels**\n\n5.  **get_messages_details_of_channels**\n\n6.  **get_replies_of_a_messages**\n\n  \n\n  \n\n### Usage\n\n  \n\n  \n\n```\n\n  \n\nfrom graphapi.graph import GraphAPI\n\n  \n\ngraph_obj = GraphAPI(Auth_Token)\n\ngraph_obj.get_teams()\n\n  \n\n```\n\n  \n\nfrom the above code we first we import GraphAPI class from graph module\n\n  \n\nafter we need to initialize the instance of this class by passing **Authentication token** in it\n\n  \n\nthen we can use it's method you can also verify all existing methods using inbuild **dir** method\n\n  \n\nAs we listed all the available api's above :\n\nso now we will cover basics of each api's that how we can use them\n\n  \n  \n  \n\n  \n  \n\n-  **get_teams**\n\n> To use this we don't need to pass any extra arguments if you are authenticated user you can simply get all the joined teams using below method.\n\n>  `graph_obj.get_teams()`\n\n  \n\n-  **get_channels**\n\n> Channels are related to a team so if you want to access a channel then you have to pass **team_id** as a arguments eg.\n\n>  `graph_obj.get_channels(team_id)`\n\n  \n\n-  **list_all_members_of_channel**\n\n> listing all members of channel required **team_id** and **channel_id** as a arguments eg.\n\n>  `graph_obj.list_all_members_of_channel(team_id, channel_id)`\n\n  \n\n-  **get_messages_of_channels**\n\n> listing all messages of channel required **team_id** and **channel_id** as a arguments eg.\n\n>  `graph_obj.get_messages_of_channels(team_id, channel_id)`\n\n **   TeamsGraphapi  supports query params for message Api, in get_messages_of_channels query param will    be the last argument in this method which will be passed in the form of dictionary\n eg.    `graph_obj.get_messages_of_channels(team_id, channel_id,  {\"$top\": 10 })`\n \n\n\n  \n  \n\n-  **get_messages_details_of_channels**\n\n> To get message details use this method with these **team_id** , **channel_id** , **message_id** arguments\n\n>  `graph_obj.get_messages_details_of_channels(team_id, channel_id, message_id)`\n\n  \n  \n\n-  **get_replies_of_a_messages**\n\n> to get replies of message we need a team and a channel where the message reside and when we want replies of a message so we also need a message to get its reply so arguments we now need are **team_id**, **channel_id**, **message_id**   get_replies_of_a_message also works with query params  similar to -   **get_messages_of_channels**  passed  dictionary must be the last argument in the method eg.\n\n>  `graph_obj.get_replies_of_a_messages(team_id, channel_id, message_id)`\n\n  \n  \n\n## License\n\nMIT\n\n  \n\n**\u2728Keep Learning**\u2728\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "wrapper for micorsoft teams graph api's",
    "version": "0.0.5",
    "project_urls": {
        "Bug Tracker": "https://github.com/Ajay7415/graphapi/issues",
        "Homepage": "https://github.com/Ajay7415/graphapi"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f9aea889c0465dd6c506c9253d81f397bf29c9e6cb03ba069de4bd51b3590a56",
                "md5": "6ab0a7faf114c0895a4111290bf91055",
                "sha256": "656e0222128f37a5cbbe813da669b257cbb7b2dcf01e29e0be4f5fc376a1fbff"
            },
            "downloads": -1,
            "filename": "teamsgraphapi-0.0.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6ab0a7faf114c0895a4111290bf91055",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 4642,
            "upload_time": "2023-07-05T10:11:21",
            "upload_time_iso_8601": "2023-07-05T10:11:21.792134Z",
            "url": "https://files.pythonhosted.org/packages/f9/ae/a889c0465dd6c506c9253d81f397bf29c9e6cb03ba069de4bd51b3590a56/teamsgraphapi-0.0.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-05 10:11:21",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Ajay7415",
    "github_project": "graphapi",
    "github_not_found": true,
    "lcname": "teamsgraphapi"
}
        
Elapsed time: 0.12529s