Skip to main content
# pygltr
Python script to get GitLab Time Reports, it uses the GitLab API

## Usage
If you use pygltr from the command line it will get you a CSV file with a list of all issues and some basic information or an overview of the time spent per milestone.
```bash
usage: pygltr.py [-h] -t TOKEN -p PROJECT [-u URL] [-f FILE | -s]

Get time tracking data from GitLab

optional arguments:
-h, --help show this help message and exit
-t TOKEN, --token TOKEN
Private GitLab token
-p PROJECT, --project PROJECT
Project name
-u URL, --url URL URL of the GitLab API
-f FILE, --file FILE CSV output filename
-s, --shell Overview of the time spent per milestone
```

Beside of the usage as a script pygltr provides the class PyGltr which is ready to use from your own code.

### Script example

```bash
python pygltr.py -t TOKEN -p PROJECT
```
Output file (default) issues.csv:

| id | issue | milestone | estimate | spent |
|----|------------------------------------|----------------|----------|-------|
| 5 | Setup a latex template | Project setup | 7200 | 3600 |
| 4 | Define milestones | Project setup | 7200 | 5400 |
| 3 | Create a physical model | | 0 | 0 |
| 2 | Setup CI | Project setup | 7200 | 3600 |
| 1 | Functional tests support | | 0 | 0 |

or

```bash
python pygltr.py -t TOKEN -p PROJECT -s

Milestone Estimate Spent
--------------------------------------------------------------------------------
- 0h 0min 0h 0min
Physical_model 16h 0min 0h 0min
Project_setup 27h 30min 20h 0min
```

### Code example
```python
from pygltr.pygltr import PyGltr

pygltr = PyGltr(url='https://gitlab.com/api/v4/', token='PRIVATE_TOKEN', project_name='PROJECT_NAME')
user, project, issues = pygltr()
```

Metadata

Release files for pygltr 0.8.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pygltr 0.8.0
File Size Uploaded
pygltr-0.8.0.tar.gz 3.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pygltr 0.8.0
File Interpreter ABI Platform
pygltr-0.8.0-py3-none-any.whl Python 3 none any Details

Total release size: 8.4 kB

Release files / pygltr-0.8.0.tar.gz

Download URL pygltr-0.8.0.tar.gz
Size 3.0 kB
Tags Source
SHA-256 checksum
How to use checksums
092b44f0060d4cc64987f077eecced249cf6e35c8262a3f58b78b7b7fc78313d
BLAKE2b-256 checksum
How to use checksums
3667b7e05ae51856a84d393c812e05255a367a6f8cc8dfc0be1cb1cb8b3523e3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / pygltr-0.8.0-py3-none-any.whl

Download URL pygltr-0.8.0-py3-none-any.whl
Size 5.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4430934ff30873c89cf2a8c7f50ebf614e947699606519a2a16ba9c720462597
BLAKE2b-256 checksum
How to use checksums
fd51ad4239e730f870bea8a595c2475b9e2597068a6f661a19b6d7868fb1a118
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.8.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page