Short script to separate comments in Apps4Pro Planner Manager Excel files created from exporting Microsoft Planner tasks.
Microsoft Planner is a useful tool used to track Tasks in various stages of completion. Microsft Planner's web app offers the feature to export an entire plan to better manipulate and analyze Plan data. However, Microsoft's exported Excel file does not support the inclusion of comments made on Tasks.
If tracking task comments is useful to you, Apps4Pro created software called the Planner Manager which at the time of this script had a downloadable free trial version. The Planner Manager offers many added features to manipulate Microsoft Planner data, including the ability to extract comments from all Tasks in a given Plan.
However, the Planner Manager exports all comments for a given Task as a single cell in the exported .xlsx
file:
In an effort to make comments more easy to work with in Excel, this script parses the single cell comment for each task and separates it into four columns (Commenter, Comment Date, Comment Time, and Comment), and separates individual comments for any particular Task into unique rows (backfilling Task information as needed):
- pandas: a Python library for data analysis
- numpy: a Python library for handling arrays and scientific computing
- openpyxl: a Python library that reads/writes Excel 2010
.xlsx
/.xlsm
/.xltx
/.xltm
files
To get a local copy up and running follow these simple steps.
In order to use the Microsoft Planner Comment Parser, you must first have Python and pip installed on your system. If you need assistance installing these prerequisites, see the folowing steps:
-
Python is a programming language. All of this project's code base is written in Python. Download the latest version of Python and install onto your local machine.
-
Pip is the package installer for Python. Once Python is installed, open your local machine's command line and use the following command to utilize Python to install Pip:
python get-pip.py -g
Git is a version control system. In this project, Git is used to clone (copy) the most up-to-date project files from GitHub to your local machine. Download the latest version of git and install on your local machine.
This project manipulates Microsoft Excel .xlsx
files, but a local installation of Microsoft Excel is not required to run this script.
-
Open the command line on your local machine.
-
Enter the following command to use Git to clone this repository to your local machine.
git clone https://github.com/asa-leholland/microsoft-planner-comment-parser.git
- Enter the following command to use Pip to install this repository's dependencies.
pip install -r requirements.txt
To use the Microsoft Planner Comment Parser once installed, add the following line item to your project:
import microsoft-planner-comment-parser as mpcp
Locate the .xlsx
file created by Apps4Pro Planner Manager that contains the exported task information from your desired plan.
Create a local string variable for the path to this saved .xlsx
file.
Then, add the following line to your script:
mpcp.commentParser.parse(excel_file='{your path to excel file here}')
When run, this will create an additional .xlsx
file in the same directory as your initial file, and will use the same filename but will append Cleaned Comments
to the filename.
To see an example of the Ficrosoft Planner Comment Parser, navigate to the //test
directory of this project. This folder contains a single .xlsx
file that contains sample data exported from Microsoft Planner using the Planner Manager.
Next, open the command line, navigate to the installation folder and run:
python sample_test.py
This will create another .xlsx
file in the same directory where comments have been separated by column and entry.
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Asa LeHolland - [email protected]
Project Link: https://github.com/asa-leholland/microsoft-planner-comment-parser
- Apps4Pro for doing the heavy lifting in building the Planner Manager.
- othneildrew for creating the template README file that was used as the starting point for the README for this project.