Metadata-Version: 2.4
Name: gitlab-releases
Version: 0.0.3
Summary: Gitlab Releases for Django projects
Author-email: Valberto Carneiro <valbertovc@gmail.com>
License-Expression: MIT
Project-URL: changelog, https://github.com/valbertovc/gitlab-releases/blob/main/CHANGELOG.md
Project-URL: homepage, https://github.com/valbertovc/gitlab-releases
Project-URL: repository, https://github.com/valbertovc/gitlab-releases
Keywords: Django,Gitlab,releases
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Django :: 3
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4
Classifier: Framework :: Django :: 4.1
Classifier: Framework :: Django :: 5
Classifier: Framework :: Django :: 5.1
Classifier: Framework :: Django :: 5.2
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Python: <3.14,>=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: django<6,>=3
Requires-Dist: python-gitlab>=6.1.0
Dynamic: license-file


# gitlab-releases

![License](https://img.shields.io/github/license/valbertovc/gitlab-releases)
![Build Status](https://img.shields.io/github/actions/workflow/status/valbertovc/gitlab-releases/release.yml)
![Coverage](https://img.shields.io/codecov/c/github/valbertovc/gitlab-releases)
![PyPI](https://img.shields.io/pypi/v/gitlab-releases)
![Python Versions](https://img.shields.io/pypi/pyversions/gitlab-releases)
![Django Versions](https://img.shields.io/pypi/frameworkversions/django/gitlab-releases)

## Short Description

`gitlab-releases` provides a release page and changelog integration for your Django project, making it easy to display your releases if you manage them using GitLab releases feature.

## Main Features

- Display a list of releases from your GitLab repository
- Show detailed changelog for each release
- Integrate release data into your Django templates
- Simple configuration and setup

## Get Started

### Installation

```bash
pip install gitlab-releases
```

### Quick Start Example

Add `gitlab_releases` to your `INSTALLED_APPS` in `settings.py`:

```python
INSTALLED_APPS = [
    # ...existing apps...
    'gitlab_releases',
]
```

Include the app's URLs in your `urls.py`:

```python
from django.urls import path, include

urlpatterns = [
    # ...existing urls...
    path('releases/', include('gitlab_releases.urls')),
]
```

## How to Use the Package or Django App

After installation and configuration, visit `/releases/` in your Django project to see the list of releases fetched from your GitLab repository. You can customize the templates or use the provided template tags in your own templates:

```django
{% load gitlab_releases_filters %}
{% for release in releases %}
    <h2>{{ release.title }}</h2>
    <div>{{ release.description|markdown }}</div>
{% endfor %}
```

## Useful Links

- [Documentation](https://github.com/valbertovc/gitlab-releases/tree/main/docs)
- [Changelog](https://github.com/valbertovc/gitlab-releases/releases)
- [PyPI Page](https://pypi.org/project/gitlab-releases/)
- [Repository](https://github.com/valbertovc/gitlab-releases)
- [Bug Tracker](https://github.com/valbertovc/gitlab-releases/issues)
- [GitLab API Docs](https://docs.gitlab.com/ee/api/releases/)
