Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/synyx/buchungsstreber
Helper application for publishing time entries to Redmine.
https://github.com/synyx/buchungsstreber
hacktoberfest redmine
Last synced: about 2 months ago
JSON representation
Helper application for publishing time entries to Redmine.
- Host: GitHub
- URL: https://github.com/synyx/buchungsstreber
- Owner: synyx
- License: mit
- Created: 2020-10-05T12:03:20.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-24T08:57:09.000Z (6 months ago)
- Last Synced: 2024-10-19T03:19:50.505Z (3 months ago)
- Topics: hacktoberfest, redmine
- Language: Ruby
- Homepage:
- Size: 470 KB
- Stars: 13
- Watchers: 5
- Forks: 3
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: COPYING
Awesome Lists containing this project
README
Buchungsstreber (⌐⊙_⊙)
======================
[](https://sonarcloud.io/dashboard?id=com.github.synyx%3Abuchungsstreber)
[](https://sonarcloud.io/dashboard?id=com.github.synyx%3Abuchungsstreber)
[](https://sonarcloud.io/dashboard?id=com.github.synyx%3Abuchungsstreber)
[](https://sonarcloud.io/dashboard?id=com.github.synyx%3Abuchungsstreber)
Lost? -> [English README][english].
Der Buchungsstreber hilft beim konsistenten und zeitnahen Buchen in [Redmine][redmine], indem er
in einer Textdatei gepflegte Buchungen automatisch in ein oder mehrere Redmine-Systeme überträgt.
[redmine]: https://www.redmine.org
[english]: README_en.md
* [Schnacken](#schnacken)
* [Voraussetzungen](#voraussetzungen)
* [Installation](#installation)
* [Konfiguration](#konfiguration)
* [Nutzung](#nutzung)
* [Terminal User Interface](#terminal-user-interface)
* [Entwicklung](#entwicklung)
Schnacken
---------
Fragen? Hilfe notwendig? Einfach nur mal Schnacken?
* Matrix: [#buchungsstreber:synyx.de](https://matrix.to/#/!BxFxbjMxhzwOlFxvMm:synyx.de/)
* E-Mail: [[email protected]](mailto:[email protected])
* [Contribution Guidelines][contributing]
[contributing]: CONTRIBUTING.md
Voraussetzungen
---------------
- Ruby 2.x/3.x
- bundler (fuer Entwicklung)
- ncursesw (fuer buchungsstreber-tui) (Kompatibel mit Ruby Version)
- schlechte Buchungsmoral
Installation
------------
1. `gem install buchungsstreber` (Mit eingerichteter [Paketquelle][rubygems])
[rubygems]: doc/rubygems.md
Oder via git Repository:
1. Repository auschecken
2. Ruby-Gems installieren: `bundle install`
Konfiguration
------------
1. Initialisierung durchfuehren lassen via
`buchungsstreber init`
Oder
1. Konfigurationspfad für Buchungstreber erstellen:
`mkdir ~/.config/buchungsstreber`
2. Config-Datei anhand der [Beispiel-Config](example.config.yml) erstellen.
Mindestens die eigenen Redmine-API-Keys eintragen, ggf. auch den Pfad zur
Buchungs-Datei `timesheet_file` und (je nach Arbeitsweise) den Archiv-Ordner
`archive_path` anpassen: `buchungsstreber config` (edit
`~/.config/buchungsstreber/config.yml`).
Nutzung
-------
Bei erstmaliger Anwendung hilft das [TUTORIAL](./doc/tutorial.md).
Buchungen werden als Plaintext erfasst, vgl. [Beispiel](example.buchungen.yml). Jede Zeile entspricht dabei einer Buchung.
Eine "Datums-Überschrift" spezifiert das Datum der darunter folgenden Buchungen.
Eine Buchungs-Zeile hat dabei immer folgendes Format (getrennt durch Tabs oder Leerzeichen):
```yaml
- [Zeit] [Aktivität] [Ticket-Nr.] [Beschreibung]
```
### Beispiel:
```yaml
2019-01-01:
- 1.5 Orga 12345 Nachbereitung
```
In diesem Fall würden für den *01.01.2019* eineinhalb Stunden auf das Ticket #12345 gebucht.
Die Aktivität wäre dabei "Orga" und die Beschreibung "Nachbereitung".
Vollstaendige Beschreibungen fuer:
* [YAML Format](./doc/yaml_format.md)
* [Buch Format](./doc/buch_format.md)
### Let's buch it
Sobald ein paar Buchungen eingetragen sind, sollte der Buchungsstreber einfach
gestartet werden können durch: `buchungsstreber`
Keine Sorge, der Buchungsstreber validiert erst einmal die Einträge in der
Buchungs-Datei und bucht nicht direkt los.
## Terminal User Interface
Mit curses ist eine Oberflaeche vorhanden, welche zur Ueberpruefung von
Buchungen sowie zum abschliessenden Buchen verwendet werden kann.
```shell script
buchungsstreber watch today
buchungsstreber watch 2020-09-01
```
Benoetigt werden hierzu noch Rubygem Abhaengigkeiten:
* `curses`
* `listen` oder `rb-inotify` oder `filewatcher`
Bedienungsanleitung erreichbar mit `h`.
Entwicklung
-----------
* [CONTRIBUTING](./CONTRIBUTING.md)
* [Development Guide](./doc/development.md)