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:

  • 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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file shoki-2.0.2.tar.gz.

File metadata

  • Download URL: shoki-2.0.2.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for shoki-2.0.2.tar.gz
Algorithm Hash digest
SHA256 36973016196ec18c17f4dd2d51ed642f1c6ee69e756f114ae0a83adfd88c2e13
MD5 ccf1cb66545a2dbee903131dc503fbb0
BLAKE2b-256 9e38aadb277d69732c555c245d804a83916c356390e92d6baa593ebf031cca7d

See more details on using hashes here.

File details

Details for the file shoki-2.0.2-py3-none-any.whl.

File metadata

  • Download URL: shoki-2.0.2-py3-none-any.whl
  • Upload date:
  • Size: 16.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for shoki-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 42f1b5b36bc1c1a48ffd4ab18bc26c938b28fcfc02d33e338d2641a2f2fd8f33
MD5 b3b98620b5363cc3b72f252f7bd02594
BLAKE2b-256 b097d72179d091ba979602f32bf364bba37f15c687f63bb5affe6ef400e81a69

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page