No project description provided
Project description
Wartungsplan
A tool to extract events from an ical file by day or day range and perform an action per event like sending an email or opening a ticket.
Requirements
- Python 3.8
Installation instructions
# prepare the python virtual env
python3 -m venv venv
# enter the venv
source venv/bin/activate
# install dependecies
pip install -r requirements.txt
# install Wartungsplan
pip install .
# run the test suite
test/test.py
Events from icalendar
An icalendar file stored in local filesystem or localy mounted.
Can be edited with Thunderbird or even Outlook with an established
UI with all posible features of the Recurrence Rule
(https://www.rfc-editor.org/rfc/rfc5545#section-3.3.10).
RRULE:FREQ=MONTHLY;BYDAY=1TU
The config file:
[calendar]
#Directory to ics file. Calendar only needs to be readable.
directory = /media/shareX/Wartungspläne.ics
Microsoft Outlook
It is strongly recommended to explicitly sync the calendar back to its source:
Send / Receive -> Send all
The config file:
[mail]
server = smtp.example.com
port = 465
password = kCHvJeUy4Gd2XgsXXYFqUtjk
sender = tom_jones@example.com
recipient = michael_jackson@example.com
OTRS
Install optional depenency: pip install pyotrs
The config file:
[otrs]
server = http://localhost
webservicename = AutomaticTicketCreationForRecurringTasks
username = restapiuser
password = AiX3sheeIyahf8aaQuah2wio
tickettitel = Titel
queue = Queueebene1::Queueebene2
state = New
priority = 1 very low
footer = Ticket automatically created by Wartungsplan
Examples
usage: Wartungsplan [-h] [--config CONFIG] [--ics-calendar ICS_CALENDAR]
[--verbose] [--dry-run] [--logfile LOGFILE]
[--start-date START_DATE] [--end-date END_DATE]
{list,send,otrs}
positional arguments:
{list,send,otrs}
options:
-h, --help show this help message and exit
--config CONFIG, -c CONFIG
Directory to different config file. Default is
plan.conf in same Folder as plan.py
--ics-calendar ICS_CALENDAR, -i ICS_CALENDAR
Path to the ics calendar (Takes precedence over value
in config)
--verbose, -v More v's more text
--dry-run, -d Don't perform any action
--logfile LOGFILE, -w LOGFILE
Write log to file
--start-date START_DATE, -s START_DATE
Start Date e.g. 2023-05-02. Default is todays date
--end-date END_DATE, -e END_DATE
End Date e.g. 2023-05-03. Default is start-date + 1
day. (00:00:00 respectively)
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
Wartungsplan-0.2.tar.gz
(22.2 kB
view hashes)
Built Distribution
Wartungsplan-0.2-py3-none-any.whl
(19.7 kB
view hashes)
Close
Hashes for Wartungsplan-0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ccc5df12fa5eea727a2edc1f757843b1af5e47eb483f05520ea82cc8dabf19c7 |
|
MD5 | f3b5435773b0e553d4e8b01516e4678a |
|
BLAKE2b-256 | b9c5578c2ad38c4bf60a65bdae9e059ac1f1b8f23ad9084b906d7ec3f50501e2 |