shoki (書記) is a secretary in Japanese. This python program is here to help take a text only file of meeting minutes and convert it into structured data. This structured data can then be converted into other formats.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
shoki
tests
.gitignore
CONTRIBUTING.md
LICENSE
README.md
setup.py

README.md

shoki (書記)

Shoki

shoki is a secretary in Japanese. This python program is here to help take a text-only file of meeting minutes and convert it into structured data. This structured data can then be converted into other formats.

Install

pip install shoki

Usage

shoki create --location [uri]

where uri is the location of the content served with a Content-Type: text/markdown or Content-Type: text/plain encoded as utf-8.

Example

shoki create --location https://webcompat-meet.herokuapp.com/0CMnUyYMSBaQJQ97Yxc8Ww/download

History

It was initially defined for addressing the needs of Mozilla webcompat team. It's strongly inspired by W3C meetings style. We are taking minute of our meetings on CodiMD. Once the meeting has been done. We generate the minutes with a mediawiki format that we add to the list of our meetings.

Example: Web Compatibility team minutes - September 11, 2018 (raw source)

Contributing

If you wish to contribute to this project, read the contributing guidelines.

Features - ToDo

The required features are:

  • Parses meeting date and time
  • Parses agenda items and agenda owners
  • Parses agenda item description
  • Parses action items
  • Starts parsing after a dedicated string
  • Stops parsing after a dedicated string
  • Handles the output in different formats (can be extended)
  • Includes Mediawiki markup output format
  • Handles an URI for the text minutes input
  • Handles a file for the text minutes input

Some constraints:

  • Avoid using regex
  • Tests Driven