added documentation and requirements.txt

This commit is contained in:
Falko Zurell 2024-11-17 09:31:30 +01:00
parent 94e99fba85
commit 03e2ca94b7
2 changed files with 37 additions and 0 deletions

29
README.md Normal file
View file

@ -0,0 +1,29 @@
# Generate ICS from CSV
This script generates an ICS file containing events converted from a CSV file.
You'll need to install two python modules:
```
pip install -r requirements.txt
```
## example CSV file format
```
Host;Description;Date;start time;end time;Location
Max Müller;Team Meeting;20.11.2024;10:00;11:00;Berlin
Anna Löwe;Project Kickoff;21.11.2024;09:00;10:30;München
```
### Example ICS output
```
BEGIN:VEVENT
DTSTART;TZID=Europe/Berlin:20241120T100000
DTEND;TZID=Europe/Berlin:20241120T110000
SUMMARY:Team Meeting (Host: Max Müller)
LOCATION:Berlin
END:VEVENT
```

8
requirements.txt Normal file
View file

@ -0,0 +1,8 @@
arrow==1.3.0
attrs==24.2.0
ics==0.7.2
python-dateutil==2.9.0.post0
pytz==2024.2
six==1.16.0
TatSu==5.12.2
types-python-dateutil==2.9.0.20241003