get-gitlab-issues


Nameget-gitlab-issues JSON
Version 0.0.8 PyPI version JSON
download
home_pagehttps://github.com/chigwell/get-gitlab-issues
SummaryA Python package for extracting issues from GitLab repositories.
upload_time2024-06-30 15:30:47
maintainerNone
docs_urlNone
authorEugene Evstafev
requires_python>=3.6
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            [![PyPI version](https://badge.fury.io/py/get-gitlab-issues.svg)](https://badge.fury.io/py/get-gitlab-issues)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
[![Downloads](https://static.pepy.tech/badge/get-gitlab-issues)](https://pepy.tech/project/get-gitlab-issues)

# Get GitLab Issues

`Get GitLab Issues` is a Python package designed to facilitate the extraction and management of issues from GitLab repositories. This tool is essential for developers looking to streamline their issue tracking processes directly through Python scripts.

## Installation

To install `Get GitLab Issues`, you can use pip:

```bash
pip install get-gitlab-issues
```

## Usage

`Get GitLab Issues` provides a straightforward API to interact with GitLab issues. Below is an example of how to use the package to retrieve issues and check user access:

### Example

```python
from get_gitlab_issues import check_access, get_gitlab_issues, get_gitlab_issue

# Check user access
if check_access('YOUR_PRIVATE_TOKEN', 'https://gitlab.example.com'):
    print("Access verified")

# Fetch issues for a specific group
issues = get_gitlab_issues('YOUR_PRIVATE_TOKEN', 'https://gitlab.example.com', '123456')
for issue in issues:
    print(issue.title, issue.description)

# Fetch a specific issue
issue_detail = get_gitlab_issue('YOUR_PRIVATE_TOKEN', 'https://gitlab.example.com', '123456', '1')
print(issue_detail.title, issue_detail.description)
```

## Functions

- `check_access(token, url)`: Checks if the provided token has access to the GitLab API.
- `get_gitlab_issues(token, url, group_id, labels=None, iteration_id=None)`: Retrieves a list of issues from a specified group.
- `get_gitlab_issue(token, url, project_id, issue_id)`: Retrieves details for a specific issue.

## Features

- Simple installation and easy usage.
- Efficient access to GitLab issues through the API.
- Ability to check user access and retrieve specific issues or lists of issues.

## Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/chigwell/get-gitlab-issues/issues).

## License

This project is licensed under the [MIT License](https://choosealicense.com/licenses/mit/).

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/chigwell/get-gitlab-issues",
    "name": "get-gitlab-issues",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": null,
    "author": "Eugene Evstafev",
    "author_email": "chigwel@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/25/ec/5f3cd32d76e2ee9ebf8f8da812deea2258882ac64d308af7143992af07a5/get-gitlab-issues-0.0.8.tar.gz",
    "platform": null,
    "description": "[![PyPI version](https://badge.fury.io/py/get-gitlab-issues.svg)](https://badge.fury.io/py/get-gitlab-issues)\n[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)\n[![Downloads](https://static.pepy.tech/badge/get-gitlab-issues)](https://pepy.tech/project/get-gitlab-issues)\n\n# Get GitLab Issues\n\n`Get GitLab Issues` is a Python package designed to facilitate the extraction and management of issues from GitLab repositories. This tool is essential for developers looking to streamline their issue tracking processes directly through Python scripts.\n\n## Installation\n\nTo install `Get GitLab Issues`, you can use pip:\n\n```bash\npip install get-gitlab-issues\n```\n\n## Usage\n\n`Get GitLab Issues` provides a straightforward API to interact with GitLab issues. Below is an example of how to use the package to retrieve issues and check user access:\n\n### Example\n\n```python\nfrom get_gitlab_issues import check_access, get_gitlab_issues, get_gitlab_issue\n\n# Check user access\nif check_access('YOUR_PRIVATE_TOKEN', 'https://gitlab.example.com'):\n    print(\"Access verified\")\n\n# Fetch issues for a specific group\nissues = get_gitlab_issues('YOUR_PRIVATE_TOKEN', 'https://gitlab.example.com', '123456')\nfor issue in issues:\n    print(issue.title, issue.description)\n\n# Fetch a specific issue\nissue_detail = get_gitlab_issue('YOUR_PRIVATE_TOKEN', 'https://gitlab.example.com', '123456', '1')\nprint(issue_detail.title, issue_detail.description)\n```\n\n## Functions\n\n- `check_access(token, url)`: Checks if the provided token has access to the GitLab API.\n- `get_gitlab_issues(token, url, group_id, labels=None, iteration_id=None)`: Retrieves a list of issues from a specified group.\n- `get_gitlab_issue(token, url, project_id, issue_id)`: Retrieves details for a specific issue.\n\n## Features\n\n- Simple installation and easy usage.\n- Efficient access to GitLab issues through the API.\n- Ability to check user access and retrieve specific issues or lists of issues.\n\n## Contributing\n\nContributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/chigwell/get-gitlab-issues/issues).\n\n## License\n\nThis project is licensed under the [MIT License](https://choosealicense.com/licenses/mit/).\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Python package for extracting issues from GitLab repositories.",
    "version": "0.0.8",
    "project_urls": {
        "Homepage": "https://github.com/chigwell/get-gitlab-issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "65b418187a279408e1852a4a4ea500c2e5ac7f8c00d5de8ec43e1e6c80509864",
                "md5": "7874866ccfbc2abd9715b2b5347e5fc1",
                "sha256": "8895f7fd757729381ba5c0596579c82ede2fe29860cf1d19a0966b4b550e13cb"
            },
            "downloads": -1,
            "filename": "get_gitlab_issues-0.0.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7874866ccfbc2abd9715b2b5347e5fc1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 4600,
            "upload_time": "2024-06-30T15:30:44",
            "upload_time_iso_8601": "2024-06-30T15:30:44.486094Z",
            "url": "https://files.pythonhosted.org/packages/65/b4/18187a279408e1852a4a4ea500c2e5ac7f8c00d5de8ec43e1e6c80509864/get_gitlab_issues-0.0.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "25ec5f3cd32d76e2ee9ebf8f8da812deea2258882ac64d308af7143992af07a5",
                "md5": "8f05a809259db15bc5191b8489f42cc7",
                "sha256": "3e84a5d9664629b1873821b288c13d3237f73ef5757433a84eed0eee08a28b02"
            },
            "downloads": -1,
            "filename": "get-gitlab-issues-0.0.8.tar.gz",
            "has_sig": false,
            "md5_digest": "8f05a809259db15bc5191b8489f42cc7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 3819,
            "upload_time": "2024-06-30T15:30:47",
            "upload_time_iso_8601": "2024-06-30T15:30:47.504854Z",
            "url": "https://files.pythonhosted.org/packages/25/ec/5f3cd32d76e2ee9ebf8f8da812deea2258882ac64d308af7143992af07a5/get-gitlab-issues-0.0.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-30 15:30:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "chigwell",
    "github_project": "get-gitlab-issues",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "get-gitlab-issues"
}
Eugene Evstafev
Elapsed time: 1.95211s