Giter VIP home page Giter VIP logo

microsoft-planner-comment-parser's Introduction

Microsoft Planner Comment Parser

Short script to separate comments in Apps4Pro Planner Manager Excel files created from exporting Microsoft Planner tasks.

About The Project

Comment Parser Example Use

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:

Example Comments Uncleaned

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):

Example Comments Cleaned

Built With

  • 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

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

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.

Installation

  1. Open the command line on your local machine.

  2. 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
  1. Enter the following command to use Pip to install this repository's dependencies.
pip install -r requirements.txt

Usage

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.

Usage Example with Sample File

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.

Sample Comments Uncleaned

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.

Sample Comments Cleaned

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

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.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Asa LeHolland - [email protected]

Project Link: https://github.com/asa-leholland/microsoft-planner-comment-parser

Acknowledgements

microsoft-planner-comment-parser's People

Contributors

asa-holland avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.