Skip to main content

Generate minutes from a text file

Project description

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:

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

Some constraints:

  • <input type="checkbox" checked="" disabled="" /> Avoid using regex
  • <input type="checkbox" checked="" disabled="" /> 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.

Files for shoki, version 2.0.2
Filename, size File type Python version Upload date Hashes
Filename, size shoki-2.0.2-py3-none-any.whl (16.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size shoki-2.0.2.tar.gz (8.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page