Skip to content

Latest commit

 

History

History
163 lines (115 loc) · 4.88 KB

README.rst

File metadata and controls

163 lines (115 loc) · 4.88 KB
Raw

RPA Framework - MS Graph

Table of Contents

Introduction

RPA Framework - MS Graph is a standalone Robot Framework library made similarly to the `RPA Framework`_ project. It is standalone as an example of how to build such libraries. The final code of this library will be included directly in that library, so updates should not be expected here.

Learn more about RPA at Robocorp Documentation.

The project is:

Completion Challenge

Robocorp is sponsoring an open challenge to the community to help complete this library!

In order to do so, you should fork this library and create your own branch based on main and complete the code for the below list of keywords. Once you believe your code is ready, submit a pull request back to this library on main and submit your information to the Robocorp MSGraph Challenge form.

Grading will start on September 2, 2022 and will be graded in the order they are received. The winner is the first one to meet the following criteria:

  • All keywords include documentation on use by a Robot developer, including examples in Robot Framework code.
  • All keywords signatures and return values have type hints.
  • All keywords return the appropriate type or execute the appropriate change in state.
  • All keywords are tested either via a pytest unit test or a robot test.
  • Code passes all linting checks (hint: run invoke lint before you create a pull request!).
  • Code is formatted with black.

Keywords Required

  • List files in OneDrive folder
  • Download file from OneDrive
  • Find OneDrive file
  • Download OneDrive file from share link
  • Upload file to OneDrive
  • Get Sharepoint site
  • Get Sharepoint list
  • Create Sharepoint list
  • List Sharepoint site drives
  • List files in Sharepoint site drive
  • Download file from Sharepoint

Stretch Goals

The following keywords are not required to win the competition, but they are in need:

  • List calendars
  • List calendar events
  • Get calendar event
  • Create new calendar event

Installing The Developer Environment

In order to work on this library, you will need to install the developer environment. Luckily, with the help of poetry and invoke, it should be relatively straight forward.

Follow these steps to get your VSCode`_ environment up and running (for other IDEs, you may need to find alternate tutorials):

  1. Fork this library on GitHub.
  2. Install Python on your machine, we recommend v3.9.13.
  3. Use pip to install global copies of poetry and invoke from an elevated terminal
pip install poetry invoke
  1. Clone your forked library locally.
  2. Execute the following invoke command, which should install the development environment in a local .venv folder within your repository.
invoke setup-poetry install
  1. Open a *.py file and double check that VSCode is using the correct python interpreter from the .venv folder.
  2. Run Python unit tests with invoke test-python.

Installation For Robot Developers

Learn about installing Python packages at Installing Python Packages.

Default installation method with Robocorp Developer Tools using conda.yaml:

channels:
  - conda-forge
dependencies:
  - python=3.9.13
  - pip=22.1.2
  - pip:
    - rpaframework==15.5.0
    - rpaframework-msgraph==0.1.0

Example

After installation the libraries can be directly imported inside Robot Framework:

*** Settings ***
Library    RPA.MSGraph

*** Tasks ***
Login as user
    Authorize MS Graph Client    client_id=<id-here>    client_secret=<secret-here>

The libraries are also available inside Python:

from RPA.MSGraph import MSGraph

lib = MSGraph()

lib.authorize_client("<id-here>","<secret-here>")