Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AndrewNeudegg/labtime
A Golang tool for extracting useful information from a Gitlab instance.
https://github.com/AndrewNeudegg/labtime
gitlab golang time-tracking
Last synced: 3 months ago
JSON representation
A Golang tool for extracting useful information from a Gitlab instance.
- Host: GitHub
- URL: https://github.com/AndrewNeudegg/labtime
- Owner: AndrewNeudegg
- License: mit
- Created: 2019-04-13T18:50:31.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-04-23T07:52:06.000Z (over 5 years ago)
- Last Synced: 2024-06-21T08:31:38.225Z (5 months ago)
- Topics: gitlab, golang, time-tracking
- Language: Go
- Size: 30.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - AndrewNeudegg/labtime - A Golang tool for extracting useful information from a Gitlab instance. (golang)
README
# labtime
A Golang tool for extracting useful information from a Gitlab instance.
## Contents
- [labtime](#labtime)
- [Contents](#contents)
- [State of development](#state-of-development)
- [Software Status](#software-status)
- [Description](#description)
- [Configuration](#configuration)
- [YAML Configuration file](#yaml-configuration-file)
- [Jinja2 Configuration](#jinja2-configuration)
- [Roadmap](#roadmap)
## State of development
This application is still under active development. Things may change or break, I will try to reduce the risk of this happening but I cannot commit to non breaking changes at this time.
## Software Status
| Item | Value |
| ----------- | ----- |
| Version | 0.0.1 |
| Status | Alpha |
| Testing | None |
| QA | None |
| Issues | None |
| MRs | None |
| Performance | Bad |
## Description
`labtime` will enable users to pull specific pieces information using API Tokens from the Gitlab API.
## Configuration
### YAML Configuration file
The default configuration file is always written to `config/default/config.yml`, personalised configuration should live under `config/custom/config.yml`.
```yml
instance:
url: gitlab.somedomain.com
username: coder1
accesstoken: "12345"
project: collection/project
queryconfig:
timeentrydetectionregex: /time spent/g
timeentryextractionregex: (?P[0-9]+)(mo)|(?P[0-9]+)(w)|(?P[0-9]+)(d)|(?P[0-9]+)(h)|(?P[0-9]+)(m)|(?P[0-9]+)(s)
```
### Jinja2 Configuration
To customise the output of the application edit the Jinja2 template files under `templates`. For instance `templates/IssueOverview.csv.j2` will output a CSV formatted file that will describe the time spent on all stored issues.
```jinja
{% for issue in ctx.ListProjectIssues() %}{{ issue.IID }},{{ ctx.TotalTimeSpent(issue) }}
{% endfor %}
```
This will output a file of the form:
```csv
44,1.000000
43,3.800000
42,0.000000
41,0.200000
40,0.300000
39,0.400000
38,0.000000
37,0.000000
36,0.000000
35,0.000000
34,12.800000
```
The first column is the issue number, the second is the time in booked to that issue in days.
## Roadmap
There are lots of things left to do here, this is a PoC more than an application that should be used. I would be keen to improve performance and documentation. Testing and additional functionality is a must also.
Finally I would like to package this as a `go get`table application.