https://github.com/fachschaftmathphysinfo/protocoldude
Python script to automatically process protocols.
https://github.com/fachschaftmathphysinfo/protocoldude
Last synced: 8 days ago
JSON representation
Python script to automatically process protocols.
- Host: GitHub
- URL: https://github.com/fachschaftmathphysinfo/protocoldude
- Owner: FachschaftMathPhysInfo
- License: gpl-3.0
- Created: 2019-02-26T19:37:29.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-08-04T21:48:46.000Z (almost 5 years ago)
- Last Synced: 2025-02-26T13:47:42.518Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 322 KB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Requirements
In order to run `protocoldude3.py` you need to install a few python modules.
The needed modules are listen in the file `requirements.txt`, you can therefore install them using `pip`.
```
# pip3 install -r requirements.txt
```
or
```
$ pip3 install --user -r requirements.txt
```
# Running the program
```bash
$ ./protocoldude3.py
```
The name of the protocol is expected to have the format `yyyy-mm-dd.txt`.
You can get more informations by invoking the program with the `-h` flag or without any arguments.
## parsed sequences
### agenda items
It is possible to seperate agenda items like this:
```
===
TOP 1: Usage of the protocoldude
===
```
They will then be prepended with the sufficent amount of '`=`' to look like this:
```
=================================
TOP 1: Usage of the protocoldude
=================================
```
### usernames
Usernames are recogized when annotated like this and are then sent the full agenda item:
```
[...] ${kai-uwe} [...]
```
# Configuration
If there is a config.ini file in the folder where the Protocoldude3 is executed, it will be loaded. The config.ini file determines the default settings. It is also possible to specify only a part of the default settings in a config.ini file. Command line arguments overwrite the default settings.
Example of a config.ini file:
```ini
[default]
disable_mail=False
disable_path_check=False
disable_svn=False
disable_tex=False
from_address=simo@mathphys.stura.uni-heidelberg.de
mail_subject_prefix=Gemeinsame Sitzung
```