README.md

In vimc/orderly.sharepoint: Sharepoint Driver for Orderly

orderly.sharepoint

An orderly1 remote hosted on Sharepoint, using spud. This is experimental!

Usage

Configure your orderly_config.yml as, for example:

remote:
  real:
    driver: orderly.sharepoint::orderly_remote_sharepoint
    args:
      url: https://example.sharepoint.com
      site: mysite
      path: Shared Documents/orderly/real
  testing:
    driver: orderly.sharepoint::orderly_remote_sharepoint
    args:
      url: https://example.sharepoint.com
      site: mysite
      path: Shared Documents/orderly/testing

Where

• url is the base url of your Office365/Sharepoint site, such as myorg.sharepoint.com
• site is your site name on Sharepoint
• path is the path within your site name where documents will be stored

The configuration above lists two remotes, one "real" and one "testing", which we have found a useful pairing. You might configure Sharepoint to allow anyone in your group to read from both, but only certain people to push to real.

orderly.sharepoint will store files as archive/<name>/<id> where <name> is the report name and <id> is a zip archive of the report contents. These must be treated as read-only and must not be modified (they do not have a file extension to help this).

With this set up, then orderly1::pull_dependencies, orderly1::pull_archive and orderly1::push_archive will work, and you can use your Sharepoint site to distribute orderly results within your group.

License

MIT © Imperial College of Science, Technology and Medicine

vimc/orderly.sharepoint documentation built on Aug. 5, 2023, 3:43 a.m.