Metadata-Version: 2.0
Name: pygltr
Version: 0.8.0
Summary: Python script to get GitLab Time Reports
Home-page: https://github.com/murthy10/pygltr
Author: Samuel Kurath
Author-email: samuel.kurath@gmail.com
License: MIT
Platform: UNKNOWN

# 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()
```

