openproject-core

Provide a Python HTTP client for the OpenProject API v3 with HAL+JSON parsing.

Updated Jan 9, 2026
One-click install
npx skills add https://github.com/hoangvantuan/claude-plugin --skill openproject-core
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: openproject-core
Source: https://github.com/hoangvantuan/claude-plugin/tree/main/skills/openproject/openproject-core
Command: npx skills add https://github.com/hoangvantuan/claude-plugin --skill openproject-core

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill provides a reusable OpenProject API v3 client and utilities to simplify building integrations with OpenProject instances, reducing boilerplate and enabling reliable API interactions.

Core Features & Use Cases

  • OpenProjectClient: a Python HTTP client with built-in API key authentication, HAL+JSON parsing, and error handling.
  • Helper utilities: build_filters(), build_sort(), paginate(), and extract_id_from_href() to simplify common API patterns.
  • HAL type definitions and error classes to standardize responses and exceptions.
  • Project configuration helpers: init_config(), load_config(), refresh_config(), require_config(), and print_config_summary() to cache project metadata and speed up repeated lookups.
  • Use cases: integrate external tooling to fetch projects, members, statuses, and work packages, then render dashboards or drive automated workflows.

Quick Start

Navigate to the skill directory and run a Claude session, e.g. uv run python code using the openproject_core module:

  • cd .claude/skills/openproject/openproject-core
  • uv run python -c "from openproject_core import OpenProjectClient; client = OpenProjectClient(base_url='https://your-openproject-instance', api_key='your-key'); print(client.check_connection())"

Frequently Asked Questions about openproject-core

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I connect to the OpenProject API using Python and handle HAL+JSON responses?

You can connect to the OpenProject API using a Python client that manages API key authentication and automatically parses HAL+JSON responses. This approach provides a consistent HTTP interface with built-in error handling for reliable integration.

What is the best way to handle OpenProject API pagination and filters programmatically?

The best way to handle OpenProject API pagination and filters is using dedicated helper utilities like build_filters and paginate. These functions simplify common API patterns by constructing query parameters and managing paginated responses programmatically.

Does the OpenProject API v3 client require external dependencies to manage configuration?

The OpenProject API v3 client operates without external dependencies, using only built-in modules. It includes project configuration helpers like init_config and load_config to cache metadata locally and speed up repeated lookups without requiring extra libraries.

Can I automate work package workflows by fetching data from OpenProject instances?

You can automate work package workflows by fetching data from OpenProject instances through a reusable API client. It enables developers to reliably retrieve projects, members, and statuses to drive automated workflows and render dashboards.

Why does my OpenProject integration keep failing when parsing API responses?

OpenProject integrations often fail when parsing API responses due to unhandled HAL+JSON structures or missing error handling. Using a standardized client with built-in HAL+JSON parsing and error classes ensures consistent response processing and prevents these failures.