Metadata-Version: 2.1
Name: TimeForge
Version: 1.1.0
Summary: Create realistic looking but fake time documentation for your student job at KIT
Author-email: Michael Hohenstein <michael@hohenste.in>
Project-URL: Homepage, https://github.com/MitchiLaser/timeforge
Project-URL: Repository, https://github.com/MitchiLaser/timeforge
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Natural Language :: German
Classifier: Topic :: Office/Business
Classifier: Topic :: Office/Business :: Scheduling
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: argcomplete >=3.0.5
Requires-Dist: feiertage-de >=0.1.0
Requires-Dist: requests >=2.31.0
Requires-Dist: pypdf >=3.10.0
Requires-Dist: ConfigArgParse >=1.7

# TimeForge
Create realistic looking but fake time documentation for your student job at KIT

## Call for participation

This is only a prototype with a lot of features that can be added. Unfortunately I do not have a lot of time to care for my project alone. If anyone wants to submit pull requests: Feel free to do so. 

## Installation

Installation via pip:

``` bash
$ pip install timeforge
```


## Usage

This program has currently only a command line interface. Use

``` bash
$ timeforge --help
```

to get an overview of the functionality. The PDF document with the form will be automatically downloaded from the PSE homepage.

## Configuration file

This program also supports a configuration file for the `--` command line arguments. Config file syntax is: `key = value`. Usually command line arguments are overwriting the config file. Example:

```
name = "Max Mustermann"
salary = 12.00
personell = 1234567
organisation = PSE
job = "Tutorium"
```

In this example: When calling `timeforge -c path/to/config.conf` the arguments `-n -s -p -o` and `-j` don't have to be passed anymore.

Furthermore this tool has a rudimentary but working UI. Only Linux and MAC are supported, maybe it also works on Windows. Call

``` bash
$ timeforge-tui
```

to start the user interface
