https://github.com/webu/dalec-openproject

DALEC -- Aggregate a lot of openproject content for django
https://github.com/webu/dalec-openproject

aggegator dalec django openproject

Last synced: 4 months ago
JSON representation

DALEC -- Aggregate a lot of openproject content for django

• Host: GitHub
• URL: https://github.com/webu/dalec-openproject
• Owner: webu
• License: bsd-3-clause
• Created: 2023-06-26T13:09:28.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-04T15:37:33.000Z (almost 3 years ago)
• Last Synced: 2026-01-08T00:20:50.806Z (6 months ago)
• Topics: aggegator, dalec, django, openproject
• Language: Python
• Homepage:
• Size: 22.5 KB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

          
# 🔗 dalec-openproject

[![Stable Version](https://img.shields.io/pypi/v/dalec-openproject?color=blue)](https://pypi.org/project/dalec-openproject/)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

[![semver](https://img.shields.io/badge/semver-2.0.0-green)](https://semver.org/)

[![Documentation Status](https://readthedocs.org/projects/dalec-openproject/badge/?version=latest)](https://dalec-openproject.readthedocs.io/en/latest/?badge=latest)

Django Aggregate a Lot of External Content -- OpenProject

Aggregate last work packages from a given OpenProject instance.

Plugin of [🤖 dalec](https://github.com/webu/dalec).

## Installation

```

pip install dalec-openproject

```

In django settings `INSTALLED_APPS`, add:

```

INSTALLED_APPS = [

    ...

    "dalec",

    "dalec_prime",

    "dalec_openproject",

    ...

    ]

```

## Usage

General usage:

```django

{% load dalec %}

{% dalec "openproject" content_type [channel=None] [channel_object=None] [template=None] %}

```

Real examples:

### Work packages

Retrieves latest work packages of a project defined by its identifier (i.e. slug):

```django

{% dalec "openproject" "work_package" channel="project" channel_object="project-identifier"%}

```

## Settings

Django settings must define:

  - `DALEC_OPENPROJECT_BASE_URL` : OpenProject instance url (ex: `https://openproject.org/`)

  - `DALEC_OPENPROJECT_API_KEY` : OpenProject api key (ex: `admazerazerazerazerazer`)