Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/karlcow/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.
https://github.com/karlcow/shoki
meeting minutes mozilla python webcompat
Last synced: 3 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/karlcow/shoki
- Owner: karlcow
- License: mpl-2.0
- Created: 2017-06-21T02:21:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-20T15:48:18.000Z (10 months ago)
- Last Synced: 2024-10-01T14:10:26.115Z (3 months ago)
- Topics: meeting, minutes, mozilla, python, webcompat
- Language: Python
- Size: 66.4 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
This is a python 3 program (replace pip by pip3 if your default install is python 2.*)
```bash
pip install shoki
```
## Usage
```bash
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
```bash
shoki create --location https://webcompat-meet.herokuapp.com/0CMnUyYMSBaQJQ97Yxc8Ww/download
```
## History
It was initially defined for addressing the needs of [Mozilla webcompat team](https://wiki.mozilla.org/Compatibility). It's strongly inspired by W3C meetings style. We are [taking minute](https://webcompat-meet.herokuapp.com/0CMnUyYMSBaQJQ97Yxc8Ww) 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](https://wiki.mozilla.org/Compatibility/Meetings).
Example: [Web Compatibility team minutes - September 11, 2018](https://wiki.mozilla.org/Compatibility/Meetings/2018-09-11) ([raw source](https://wiki.mozilla.org/index.php?title=Compatibility/Meetings/2018-09-11&action=edit))
## Contributing
If you wish to contribute to this project, read the [contributing guidelines](https://github.com/karlcow/shoki/blob/master/CONTRIBUTING.md).
## Features - ToDo
The required features are:
* [x] Parses meeting date and time
* [x] Parses agenda items and agenda owners
* [x] Parses agenda item description
* [x] Parses action items
* [x] Starts parsing after a dedicated string
* [x] Stops parsing after a dedicated string
* [ ] Handles the output in different formats (can be extended)
* [x] Includes Mediawiki markup output format
* [x] Handles an URI for the text minutes input
* [x] Handles a file for the text minutes input
Some constraints:
* [x] Avoid using regex
* [x] Tests Driven