Metadata-Version: 2.1
Name: glbuild
Version: 0.1.7
Summary: GitLab pipeline jobs data collector. CLI tool and Python package.
License: LICENSE
Author: Henri Aïdasso
Author-email: ahenrij@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: pandas (>=2.2.2,<3.0.0)
Requires-Dist: pydantic (>=2.7.1,<3.0.0)
Requires-Dist: pydantic-settings (>=2.2.1,<3.0.0)
Requires-Dist: python-gitlab (>=4.5.0,<5.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Requires-Dist: tqdm (>=4.66.4,<5.0.0)
Requires-Dist: types-requests (>=2.31.0.20240406,<3.0.0.0)
Requires-Dist: types-toml (>=0.10.8.20240310,<0.11.0.0)
Description-Content-Type: text/markdown

# glbuild

A tool to collect the entire history of build data and logs (at once) from GitLab projects.

## Requirements

- Python 3.10
- [Poetry](https://python-poetry.org/)

## Get started

Install dependencies

```bash
poetry install
```

Access virtual environment

```bash
poetry shell
```

Install pre-commit hook for static code analysis

```bash
pre-commit install
```

## Usage

Install the Python package using Pip

>```bash
>pip install glbuild
>```

Use in a Python script as follows:

```python
import glbuild

glb = glbuild.GitLabBuild(base_url="https://gitlab.com", token="******", projects=[1538, 5427])

glb.start(output="./data")
```

Use in a Bash command line as follows:

```bash
glbuild --base-url https://gitlab.com --token ****** --output ./data --project 1538 --project 5427
```

Contracted CLI command:

```bash
glbuild -b https://gitlab.com -t ****** -o ./data -p 1538 -p 5427
```

