Skip to main content

Generate minutes from a text file

Project description

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.


pip install shoki


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.


shoki create --location


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)


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

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shoki-2.0.2.tar.gz (8.1 kB view hashes)

Uploaded source

Built Distribution

shoki-2.0.2-py3-none-any.whl (16.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page