-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
64 additions
and
193 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,4 @@ | ||
| About | ||
| ===== | ||
|
|
||
| Copying meetings from the calendar to the ITC system is a tedious task. | ||
| Furthermore, it would be nice if an event could already specify on which contract | ||
| it should be booked. | ||
|
|
||
| ``adnitc`` adresses these problems. It allows to parse the information contained in | ||
| the comment field of an event and creates the corersponding ITC entries. | ||
| ``seriesManagementSystem`` is a tool to administrate a pool of individual exercisese out of which weekly exercice lessons - a series - can be created. Each exercise come with the task and its solution. The idea is to create weekly collections of exercises - series - which are then distributed to the students. After a week they have to hand in their solutions. During the next lesson the solution sheet is distributed. The ``seriesManagementSystem`` allows to dynamically create these series out of the bucket of available individual exercises. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,34 @@ | ||
| Usage | ||
| ================= | ||
|
|
||
| Upon the first start a copy of a pristine application and logging configuration are created in the user's home directory ``~/.AdNITC/``. From this point on configuration files are read from this location. See see :ref:`configuration` section for more information. | ||
|
|
||
|
|
||
| This script downloads the specified calendars and parses all events in them. For each event, it will try to create a corresponding ITC entry. In order to do so, the calendar items need to be enhanced with some special information, targeted specially to the ITC system of AdNovum. | ||
|
|
||
| * The *Title* of an event automatically gets copied to the **comment** section of the corresponding ITC entry. | ||
| * The *Comment* of an event can be used as normally but should contain somewhere the following block:: | ||
|
|
||
| ################ | ||
| itctag:UBS STMP.Wave_25:dev | ||
| ticket:STMPPLAT-16969 | ||
| jira:true | ||
| zimbra:false | ||
| ################ | ||
| Installation | ||
| ------------- | ||
|
|
||
| * not all information is mandatory: | ||
| From pipx | ||
| ^^^^^^^^^^ | ||
|
|
||
| * ``itctag`` is mandatory. | ||
| * ``ticket`` is optional, if not specified nothing will be written to the ticket field of the ITC system. | ||
| * ``jira`` is optional and defaults to false | ||
| * ``zimbra`` is optional and defaults to false | ||
| Simply run:: | ||
|
|
||
| pipx install seriesManagementSystem | ||
|
|
||
|
|
||
| Uninstall | ||
| ----------- | ||
|
|
||
| Via pip:: | ||
|
|
||
| pips uninstall missingTVShows | ||
|
|
||
| * It does not matter how many ``#######`` you use, but you need to put at least 3 of them. Before and after this section you can put wathever text you want. | ||
|
|
||
|
|
||
| .. _configuration: | ||
|
|
||
| Configuration | ||
| -------------- | ||
| Upon the first launch, the script creates the ``~/.AdNITC/`` directory containing: | ||
| * logging.conf where the logger is configured | ||
| * adnitc.conf where the general configuration is stored. Adapt at least the ``<calendars>``, ``<calendarurl>`` of the specified calendar, ``<itcurl>`` and ``<user>`` properties to get started. The script will interactively ask for passwords when the ``<user>`` tag is set for the *ITC* section or for a *Calendar* section. | ||
|
|
||
| The example below shows what such a file could look like:: | ||
|
|
||
| [Config] | ||
| # Comma-separated list of calendars to parse for ITC events | ||
| calendars: cal1 | ||
| # Shall we first try to do bulk updates (this is the preferred method) | ||
| usebulk: true | ||
| # Verify SSL certificates | ||
| verifyssl: true | ||
|
|
||
| [cal1] | ||
| # Replace XXX with your username | ||
| url: http://adnzimzh.zh.adnovum.ch:8080/home/XXX@zimbra.adnovum.ch/Calendar | ||
|
|
||
| [cal2] | ||
| # If a resource requires authentication (basic auth) you can specify | ||
| # the crendentials with user and pass. | ||
| # if you omit the password, then adnitc will ask for it interactively. | ||
| url: https://example.com/my_hard_work.ics | ||
| user: XXX | ||
| pass: ZZZ | ||
|
|
||
| [ITC] | ||
| # adnitc will aks for the password interactively. | ||
| url: https://aww.adnovum.ch/itc | ||
| user: XXX | ||
|
|
||
| The config file has 3 sections *Config* where general options sit, *cal1* contains url and credentials for the first calendar and *ITC* specifies url and credentials for the ITC system. | ||
|
|
||
| .. _debugging_and_logging: | ||
|
|
||
| Debugging and Logging | ||
| --------------------- | ||
| As the script is run, this folder will also host a ``adnitc.log`` file, containing the log of the *last* run. | ||
|
|
||
| Upon the first launch, the script creates the ~/.seriesmgmtsystem/ directory containing: | ||
| * logging.yaml where the logger is configured | ||
| * seriesmgmtsystem.conf where the general configuration is stored. |