Metadata-Version: 2.1
Name: gitlabx
Version: 0.10.4
Summary: Uma Lib para buscar dados do Gitlab
Home-page: https://gitlab.com/immigrant-data-driven-development/libs/application/gitlab
Author: Carlos Henrique Maulaz de Freitas
Author-email: carlosmaulaz@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: factory-boy
Requires-Dist: python-gitlab

# GitlabX

## General Information
* **Software**:GitLabX
* **Author**: Carlos Henrique Maulaz de Freitas
* **Author's e-mail**:carlosmaulaz@gmail.com
* **Source Repository**: [https://gitlab.com/immigrant-data-driven-development/libs/application/gitlab](https://gitlab.com/immigrant-data-driven-development/libs/application/gitlab)  

## Goal
A Lib to retrive data from GitLabx

## Documentation

The Documentation can be found in this [link](./docs/documentation.md)

## Generate documentation

To create the code documentation:
```bash
pdoc --html --force gitlabx/ --output docs

```
### Acess code documentation	

To accesss the documenation, go to folder docs/gitlabx and open index.html 
	
## Instalation

To install gitlabx, run this command in your terminal:
```bash
pip install gitlabx
```

## Usage

```python

from gitlabx import factories
from pprint import pprint 
from decouple import config

token = config('TOKEN_GITLAB')

personal_access_token =  token

service = factories.Project(personal_access_token=personal_access_token)

result = service.get_all(today=False)

for element in result:
    pprint (element)

```


