| Name | ChannelExporter-Teams JSON |
| Version |
1.6
JSON |
| download |
| home_page | None |
| Summary | A package to automate Microsoft Teams interactions and collate feedback as df or excel from the desired Channel -> SubChannel. |
| upload_time | 2025-02-16 17:47:39 |
| maintainer | None |
| docs_url | None |
| author | Abhishek Venkatachalam |
| requires_python | >=3.6 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ChannelExporter_Teams
## Overview
The **ChannelExporter_Teams** package allows users to automate interactions with Microsoft Teams, facilitating the export of channel feedback into structured formats like Excel or DataFrames. This package uses Selenium for browser automation and BeautifulSoup for HTML parsing.
## Features
- Seamless integration with Microsoft Teams.
- Export channel data to Excel files or DataFrames.
- Flexible parameters for browser configurations.
- Automatic management of Chromedriver installation.
## Installation
To install the ChannelExporter_Teams package, you can use pip:
```bash
pip install ChannelExporter_Teams
```
Ensure you have the required dependencies installed, which include `selenium`, `pandas`, `beautifulsoup4`, and `psutil`.
## Usage
### Function 1: Chrome_export_TeamsChannel_excel
This function exports data from a specified Microsoft Teams channel to an Excel file.
### Example 1: Using Default Arguments
You can call the function using the required parameters, allowing the use of default values for optional parameters.
```Python
# Importing the library.
import ChannelExporter_Teams as cet
# Define required parameters
user_data_directory = r'C:/Users/YourUsername/AppData/Local/Google/Chrome/User Data'
profile_directory = 'Default'
output_file = 'teams_feedback.xlsx'
channel_name = 'Your Channel Name'
sub_channel_name = 'Your Sub Channel Name'
# Call the function with default arguments for optional parameters
cet.Chrome_export_TeamsChannel_excel(user_data_directory, profile_directory, output_file, channel_name, sub_channel_name)
```
### Example 2: Using Default and Advanced Keyword Arguments with Browser UI.
You can also customize the function call by specifying values for optional parameters.
```Python
# Importing the library.
import ChannelExporter_Teams as cet
# Define your parameters
user_data_directory = r'C:/Users/YourUsername/AppData/Local/Google/Chrome/User Data'
profile_directory = 'Default'
output_file = 'teams_feedback_custom.xlsx'
channel_name = 'Your Channel Name'
sub_channel_name = 'Your Sub Channel Name'
# Call the function with custom settings
cet.Chrome_export_TeamsChannel_excel(
user_data_dir=user_data_directory,
profile_directory=profile_directory,
output_filename=output_file,
channelName=channel_name,
subChannelName=sub_channel_name,
isHeadless=False, # Run the browser in UI mode
window_height="1200", # Customize window height
window_width="1600" # Customize window width
scalefactor = "0.5", # UI scaling factor
teams_button_xpath = "//button[@aria-label='Teams']", # futureproofing the xpaths
channel_pane_xpath = "//div[@data-tid='app-layout-area--main']" # futureproofing the xpaths.
)
```
### Function 2: Chrome_export_TeamsChannel_df
This function exports data from a specified Microsoft Teams channel to a DataFrame.
### Example 3: Headlessly and DataFrame - Using Default and Advanced Keyword Arguments with NO Browser UI.
To run the browser in headless mode (without a visible UI), simply set the isHeadless parameter to True. This is useful for automated scripts running in environments where a graphical interface may not be available.
The output is a Dataframe this time, the same settings can also be used with the excel method - 'Chrome_export_TeamsChannel_df'
```Python
# Importing the library.
import ChannelExporter_Teams as cet
# Define your parameters for headless mode
user_data_directory = r'C:/Users/YourUsername/AppData/Local/Google/Chrome/User Data'
profile_directory = 'Default'
output_file = 'teams_feedback_headless.xlsx'
channel_name = 'Your Channel Name'
sub_channel_name = 'Your Sub Channel Name'
# Call the function with headless mode enabled
df_Output = cet.Chrome_export_TeamsChannel_df(
user_data_dir=user_data_directory,
profile_directory=profile_directory,
output_filename=output_file,
channelName=channel_name,
subChannelName=sub_channel_name,
isHeadless=True, # Run the browser in headless mode
headless_height="1080", # Customize headless window height
headless_width="1920", # Customize headless window width
headless_scalefactor = "0.5", # Headless scale factor.
teams_button_xpath = "//button[@aria-label='Teams']", # futureproofing the xpaths
channel_pane_xpath = "//div[@data-tid='app-layout-area--main']" # futureproofing the xpaths.
)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "ChannelExporter-Teams",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Abhishek Venkatachalam",
"author_email": "abhishek.venkatachalam06@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/57/0b/e9460f9b19d6213ac0f27714bfbee33ef81f1857762a925e65e288863e06/channelexporter_teams-1.6.tar.gz",
"platform": null,
"description": "# ChannelExporter_Teams\n\n## Overview\n\nThe **ChannelExporter_Teams** package allows users to automate interactions with Microsoft Teams, facilitating the export of channel feedback into structured formats like Excel or DataFrames. This package uses Selenium for browser automation and BeautifulSoup for HTML parsing.\n\n## Features\n\n- Seamless integration with Microsoft Teams.\n- Export channel data to Excel files or DataFrames.\n- Flexible parameters for browser configurations.\n- Automatic management of Chromedriver installation.\n\n## Installation\n\nTo install the ChannelExporter_Teams package, you can use pip:\n\n```bash\npip install ChannelExporter_Teams\n```\n\nEnsure you have the required dependencies installed, which include `selenium`, `pandas`, `beautifulsoup4`, and `psutil`.\n\n## Usage\n\n### Function 1: Chrome_export_TeamsChannel_excel\nThis function exports data from a specified Microsoft Teams channel to an Excel file.\n\n### Example 1: Using Default Arguments\n\nYou can call the function using the required parameters, allowing the use of default values for optional parameters.\n\n\n```Python \n# Importing the library.\nimport ChannelExporter_Teams as cet\n\n# Define required parameters\nuser_data_directory = r'C:/Users/YourUsername/AppData/Local/Google/Chrome/User Data'\nprofile_directory = 'Default'\noutput_file = 'teams_feedback.xlsx'\nchannel_name = 'Your Channel Name'\nsub_channel_name = 'Your Sub Channel Name'\n\n# Call the function with default arguments for optional parameters\ncet.Chrome_export_TeamsChannel_excel(user_data_directory, profile_directory, output_file, channel_name, sub_channel_name)\n```\n\n\n### Example 2: Using Default and Advanced Keyword Arguments with Browser UI.\n\nYou can also customize the function call by specifying values for optional parameters.\n\n```Python \n# Importing the library.\nimport ChannelExporter_Teams as cet\n\n# Define your parameters\nuser_data_directory = r'C:/Users/YourUsername/AppData/Local/Google/Chrome/User Data'\nprofile_directory = 'Default'\noutput_file = 'teams_feedback_custom.xlsx'\nchannel_name = 'Your Channel Name'\nsub_channel_name = 'Your Sub Channel Name'\n\n# Call the function with custom settings\ncet.Chrome_export_TeamsChannel_excel(\n user_data_dir=user_data_directory,\n profile_directory=profile_directory,\n output_filename=output_file,\n channelName=channel_name,\n subChannelName=sub_channel_name,\n isHeadless=False, # Run the browser in UI mode\n window_height=\"1200\", # Customize window height\n window_width=\"1600\" # Customize window width\n scalefactor = \"0.5\", # UI scaling factor\n teams_button_xpath = \"//button[@aria-label='Teams']\", # futureproofing the xpaths\n channel_pane_xpath = \"//div[@data-tid='app-layout-area--main']\" # futureproofing the xpaths.\n)\n```\n\n### Function 2: Chrome_export_TeamsChannel_df\nThis function exports data from a specified Microsoft Teams channel to a DataFrame.\n\n\n### Example 3: Headlessly and DataFrame - Using Default and Advanced Keyword Arguments with NO Browser UI.\n\nTo run the browser in headless mode (without a visible UI), simply set the isHeadless parameter to True. This is useful for automated scripts running in environments where a graphical interface may not be available.\n\nThe output is a Dataframe this time, the same settings can also be used with the excel method - 'Chrome_export_TeamsChannel_df'\n\n\n```Python \n# Importing the library.\nimport ChannelExporter_Teams as cet\n\n# Define your parameters for headless mode\nuser_data_directory = r'C:/Users/YourUsername/AppData/Local/Google/Chrome/User Data'\nprofile_directory = 'Default'\noutput_file = 'teams_feedback_headless.xlsx'\nchannel_name = 'Your Channel Name'\nsub_channel_name = 'Your Sub Channel Name'\n\n# Call the function with headless mode enabled\ndf_Output = cet.Chrome_export_TeamsChannel_df(\n user_data_dir=user_data_directory,\n profile_directory=profile_directory,\n output_filename=output_file,\n channelName=channel_name,\n subChannelName=sub_channel_name,\n isHeadless=True, # Run the browser in headless mode\n headless_height=\"1080\", # Customize headless window height\n headless_width=\"1920\", # Customize headless window width\n headless_scalefactor = \"0.5\", # Headless scale factor.\n teams_button_xpath = \"//button[@aria-label='Teams']\", # futureproofing the xpaths\n channel_pane_xpath = \"//div[@data-tid='app-layout-area--main']\" # futureproofing the xpaths.\n)\n```\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A package to automate Microsoft Teams interactions and collate feedback as df or excel from the desired Channel -> SubChannel.",
"version": "1.6",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1a65424fc8c36473fa3078e7d26b757869087223ade58bc5f7b97b1875484585",
"md5": "8520d7c102a3cfab344c7633947dca05",
"sha256": "128832443ebffef8b4806c58aea513a6954fd1f775ca01fb38cd144b776fc780"
},
"downloads": -1,
"filename": "ChannelExporter_Teams-1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8520d7c102a3cfab344c7633947dca05",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 15885,
"upload_time": "2025-02-16T17:47:37",
"upload_time_iso_8601": "2025-02-16T17:47:37.800511Z",
"url": "https://files.pythonhosted.org/packages/1a/65/424fc8c36473fa3078e7d26b757869087223ade58bc5f7b97b1875484585/ChannelExporter_Teams-1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "570be9460f9b19d6213ac0f27714bfbee33ef81f1857762a925e65e288863e06",
"md5": "43ba02bfd4864c6dfe8ecdd45d99883b",
"sha256": "49888bde838a1dd8407177443100d0070b679ed3453b7c595412bf5437e0791a"
},
"downloads": -1,
"filename": "channelexporter_teams-1.6.tar.gz",
"has_sig": false,
"md5_digest": "43ba02bfd4864c6dfe8ecdd45d99883b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 14595,
"upload_time": "2025-02-16T17:47:39",
"upload_time_iso_8601": "2025-02-16T17:47:39.884424Z",
"url": "https://files.pythonhosted.org/packages/57/0b/e9460f9b19d6213ac0f27714bfbee33ef81f1857762a925e65e288863e06/channelexporter_teams-1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-16 17:47:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "channelexporter-teams"
}
