Compare commits
9
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2e19639e12 | ||
|
|
847f8ab3f4 | ||
|
|
10ea9277c9 | ||
|
|
1c9f95a11f | ||
|
|
57c1910734 | ||
|
|
7efb302c10 | ||
|
|
ab56ba0c64 | ||
|
|
6613c9ef29 | ||
|
|
21d709afbd |
No files matched your search
@@ -36,7 +36,7 @@
|
||||
{
|
||||
"name": "redmine",
|
||||
"source": "./plugins/redmine",
|
||||
"description": "Redmine via REST-API: Projekte/Tickets auflisten, anzeigen, anlegen, aktualisieren und kommentieren via redmine.py (API-Key lokal)."
|
||||
"description": "Redmine via REST-API: Projekte, Tickets, Versionen und News auflisten, anzeigen, anlegen, aktualisieren und kommentieren via redmine.py (API-Key lokal)."
|
||||
},
|
||||
{
|
||||
"name": "grill-me",
|
||||
|
||||
@@ -110,11 +110,11 @@ self-contained `wiki.py` (`fetch`/`render`/`search`/`update`). Instanzen `wiki`
|
||||
|
||||
### redmine
|
||||
|
||||
Redmine (redmine.inmedias.it) über die REST-API: Projekte und Tickets auflisten,
|
||||
anzeigen, anlegen, aktualisieren und kommentieren — via mitgelieferter,
|
||||
self-contained `redmine.py` (`me`/`projects`/`issues`/`show`/`create`/`update`/
|
||||
`comment`/`meta`). Namen (Projekt/Tracker/Status/Priorität) werden auf IDs
|
||||
aufgelöst.
|
||||
Redmine (redmine.inmedias.it) über die REST-API: Projekte, Tickets, Versionen
|
||||
und News auflisten, anzeigen, anlegen, aktualisieren und kommentieren — via
|
||||
mitgelieferter, self-contained `redmine.py` (`me`/`projects`/`issues`/`show`/
|
||||
`create`/`update`/`comment`/`news`/`versions`/`meta`). Namen (Projekt/Tracker/
|
||||
Status/Priorität/Version) werden auf IDs aufgelöst.
|
||||
|
||||
- Voraussetzung: `REDMINE_URL` und persönlicher `REDMINE_API_KEY` als
|
||||
Umgebungsvariable bzw. dotenv-Datei (kein Key im Plugin). API-Key unter
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "humhub",
|
||||
"version": "0.3.0",
|
||||
"version": "0.4.1",
|
||||
"description": "HumHub via REST-API: Wiki-Seiten, Posts, Umfragen und Kommentare auflisten, anzeigen, anlegen und aktualisieren (humhub.py).",
|
||||
"author": {
|
||||
"name": "inmedias.it"
|
||||
|
||||
@@ -94,18 +94,50 @@ und Wiki-Seiten.
|
||||
### Direktnachrichten
|
||||
|
||||
```bash
|
||||
./humhub.py mail-send <empfaenger> "<betreff>" [datei|-]
|
||||
./humhub.py mail-send <empfaenger> "<betreff>" [datei|-] # Probelauf
|
||||
./humhub.py mail-send <empfaenger> "<betreff>" [datei|-] --send # senden
|
||||
./humhub.py mail-send https://humhub.inmedias.it/u/serge/ "Betreff" entwurf.md
|
||||
./humhub.py mail-send jan.stobbe,26 "Betreff" -
|
||||
./humhub.py mail-send jan.stobbe,26 "Betreff" - --send
|
||||
./humhub.py mail-reply <konversations-id> [datei|-]
|
||||
./humhub.py mail-user-remove <konversations-id> <empfaenger>
|
||||
```
|
||||
|
||||
Empfänger sind Benutzername, Profil-URL oder numerische ID; mehrere mit Komma.
|
||||
**Ohne `--send` wird nichts gesendet**, sondern nur aufgelöst und angezeigt,
|
||||
wer die Nachricht bekäme — der Probelauf ist der Default.
|
||||
|
||||
**`recipient` will GUIDs, keine User-IDs.** `mail-send` löst jede Angabe
|
||||
deshalb bis zur GUID auf (`/user/<id>` liefert sie, die Benutzerliste je nach
|
||||
Fassung nicht). Mit numerischen IDs antwortet die API `400 Validation failed`
|
||||
und „Du kannst keine Nachricht ohne Empfänger senden!" — die Meldung klingt
|
||||
nach einem leeren Feld, obwohl das Feld gefüllt ist, und weist damit in die
|
||||
falsche Richtung.
|
||||
|
||||
`mail-reply` hängt einen Beitrag an eine bestehende Konversation
|
||||
(`POST /mail/<id>/entry`). Die ID steht in der URL der Konversation:
|
||||
`…/mail/mail/index?id=35`.
|
||||
|
||||
**Eine Fehlzustellung lässt sich nicht löschen.** `DELETE /mail/<id>` gibt es
|
||||
in dieser API-Version nicht (404, Route unbekannt), und über die Oberfläche
|
||||
kommt man auch nicht dran. Das einzige Gegenmittel ist
|
||||
`mail-user-remove`, das einen Teilnehmer wieder aus der Konversation nimmt
|
||||
(`DELETE /mail/<id>/user/<userid>`). Ob der Empfänger vorher schon eine
|
||||
Benachrichtigung bekommen hat, bleibt dabei offen.
|
||||
|
||||
**Deshalb prüft `mail-send` nach dem Versand die Teilnehmerliste.** Eine
|
||||
falsche Kennung in `recipient` führt nicht verlässlich zu einer
|
||||
Fehlermeldung: am 25.09.2026 hat die API einen Versand mit numerischen IDs
|
||||
mit `HTTP 200` quittiert und die Nachricht an einen **anderen** Benutzer
|
||||
zugestellt. Der Befehl gibt deshalb aus, wer die Konversation tatsächlich
|
||||
bekommen hat, und nennt bei einer Abweichung das `mail-user-remove`-Kommando.
|
||||
Die Teilnehmerliste kann direkt nach dem Anlegen unvollständig sein — im
|
||||
Zweifel noch einmal nachsehen, bevor man daraus einen Schluss zieht.
|
||||
|
||||
Zwei Routen, zwei Kennungen: `POST /mail` will die **GUID**,
|
||||
`DELETE /mail/<id>/user/<userid>` die **numerische ID**. Beides ist im
|
||||
Skript gekapselt, `mail-user-remove` nimmt wie alle Befehle Benutzername,
|
||||
Profil-URL oder ID.
|
||||
|
||||
**Slug ≠ Benutzername.** Zur Profil-URL `/u/serge/` gehört der Benutzername
|
||||
`Serge`, und `get-by-username` unterscheidet Groß-/Kleinschreibung. Wer den
|
||||
Slug einsetzt, bekommt sonst `User not found!`. `mail-send` fängt das ab: erst
|
||||
@@ -123,6 +155,14 @@ Container-ID, einen **Space-Slug** oder eine **Space-URL** (`resolve_container`
|
||||
löst Slug/URL selbst auf). Passende Container per `space-list` ermitteln, Seiten
|
||||
per `wiki-list` / `post-list`.
|
||||
|
||||
**HumHub macht aus Zeichenfolgen wie `:)` Emojis — auch mitten im Fachtext.**
|
||||
Am 08.10.2026 wurde aus „(0.0.0.0 und ::)“ ein „(0.0.0.0 und :😃“: der zweite
|
||||
Doppelpunkt der IPv6-Adresse `::` bildete mit der schließenden Klammer ein
|
||||
Smiley. Betroffen sind typisch IPv6-Adressen (`::`, `::1`, `[::]:3306`),
|
||||
Portangaben und Pfade direkt vor `)` oder `(`. **Solche Werte immer in
|
||||
Backticks setzen** — in Inline-Code ersetzt HumHub nichts. Vor dem Absenden
|
||||
den Text außerhalb von Backticks auf `:)`, `:(`, `;)`, `:D`, `:P` prüfen.
|
||||
|
||||
## Zugangsdaten
|
||||
|
||||
`humhub.py` bringt **keinen** Token mit. Jede/r hinterlegt ein eigenes
|
||||
|
||||
@@ -350,8 +350,20 @@ def cmd_comment_create(args: argparse.Namespace) -> None:
|
||||
|
||||
# ── Mail (Direktnachrichten) ─────────────────────────────────────────────────
|
||||
|
||||
def resolve_user(session: requests.Session, value: str) -> int:
|
||||
"""Resolve a user ID, username, or profile URL (…/u/<slug>/) to a user ID.
|
||||
def user_guid(session: requests.Session, user: dict) -> str:
|
||||
"""GUID eines Benutzers, notfalls über /user/<id> nachgeladen.
|
||||
|
||||
Die Benutzerliste liefert die GUID je nach Fassung nicht mit.
|
||||
"""
|
||||
guid = user.get("guid") or (user.get("account") or {}).get("guid")
|
||||
if guid:
|
||||
return str(guid)
|
||||
uid = user.get("id") or (user.get("account") or {}).get("id")
|
||||
return str(api_get(session, f"/user/{uid}")["guid"])
|
||||
|
||||
|
||||
def resolve_user_info(session: requests.Session, value: str) -> dict:
|
||||
"""Benutzerdatensatz zu numerischer ID, Benutzername oder Profil-URL.
|
||||
|
||||
Slug und Benutzername sind nicht dasselbe: zu https://…/u/serge/ gehört der
|
||||
Benutzername "Serge". `get-by-username` kennt nur den Benutzernamen und
|
||||
@@ -360,7 +372,7 @@ def resolve_user(session: requests.Session, value: str) -> int:
|
||||
"""
|
||||
value = value.strip()
|
||||
if value.isdigit():
|
||||
return int(value)
|
||||
return api_get(session, f"/user/{int(value)}")
|
||||
name = value
|
||||
if "/" in value:
|
||||
teile = [t for t in urlparse(value).path.split("/") if t]
|
||||
@@ -370,7 +382,7 @@ def resolve_user(session: requests.Session, value: str) -> int:
|
||||
r = session.get(f"{BASE_URL}/user/get-by-username",
|
||||
params={"username": name})
|
||||
if r.ok:
|
||||
return int(r.json()["id"])
|
||||
return r.json()
|
||||
|
||||
page = 1
|
||||
while True:
|
||||
@@ -381,26 +393,107 @@ def resolve_user(session: requests.Session, value: str) -> int:
|
||||
slug_teile = [t for t in urlparse(u.get("url", "")).path.split("/") if t]
|
||||
slug = slug_teile[-1] if slug_teile else ""
|
||||
if name.lower() in (username.lower(), slug.lower()):
|
||||
return int(u["id"])
|
||||
return u
|
||||
if len(results) < 50:
|
||||
break
|
||||
page += 1
|
||||
sys.exit(f"Error: Benutzer {value!r} nicht gefunden")
|
||||
|
||||
|
||||
def resolve_user(session: requests.Session, value: str) -> str:
|
||||
"""Resolve a user ID, username, or profile URL (…/u/<slug>/) to a user GUID.
|
||||
|
||||
**GUID, nicht ID.** `POST /mail` nimmt als `recipient` ausschließlich
|
||||
GUIDs an; mit numerischen IDs antwortet die API `400 Validation failed`
|
||||
und „Du kannst keine Nachricht ohne Empfänger senden!" — eine Meldung,
|
||||
die nach einem leeren Feld klingt, obwohl das Feld gefüllt ist.
|
||||
"""
|
||||
return user_guid(session, resolve_user_info(session, value))
|
||||
|
||||
|
||||
def mail_teilnehmer(session: requests.Session, conv_id: int) -> list[dict]:
|
||||
"""Teilnehmer einer Konversation. Leere Liste, wenn nicht lesbar."""
|
||||
r = session.get(f"{BASE_URL}/mail/{conv_id}/users")
|
||||
if not r.ok:
|
||||
return []
|
||||
daten = r.json()
|
||||
return daten if isinstance(daten, list) else daten.get("results", [])
|
||||
|
||||
|
||||
def eigene_guid(session: requests.Session) -> str:
|
||||
"""GUID des eigenen Kontos, leer wenn nicht ermittelbar."""
|
||||
r = session.get(f"{BASE_URL}/user/me")
|
||||
return str(r.json().get("guid", "")) if r.ok else ""
|
||||
|
||||
|
||||
def cmd_mail_send(args: argparse.Namespace) -> None:
|
||||
session, _ = get_session()
|
||||
ids = [resolve_user(session, teil) for teil in args.to.split(",") if teil.strip()]
|
||||
if not ids:
|
||||
leute = [resolve_user_info(session, teil)
|
||||
for teil in args.to.split(",") if teil.strip()]
|
||||
if not leute:
|
||||
sys.exit("Error: kein Empfänger angegeben")
|
||||
guids = [user_guid(session, u) for u in leute]
|
||||
namen = {g: u.get("display_name", "?") for g, u in zip(guids, leute)}
|
||||
for g in guids:
|
||||
print(f"Empfänger: {namen[g]} ({g})")
|
||||
if not args.send:
|
||||
print("PROBELAUF — nichts gesendet. Mit --send abschicken.")
|
||||
return
|
||||
|
||||
message = read_file(args.file)
|
||||
data = api_post(session, "/mail", {
|
||||
"title": args.title,
|
||||
"message": message,
|
||||
"recipient": ids,
|
||||
"recipient": guids,
|
||||
})
|
||||
empfaenger = ", ".join(str(i) for i in ids)
|
||||
print(f"Nachricht gesendet (Konversation {data.get('id')}) an Benutzer {empfaenger}")
|
||||
conv_id = data.get("id")
|
||||
print(f"Nachricht gesendet (Konversation {conv_id})")
|
||||
|
||||
# Gegenprobe. Am 25.09.2026 hat die API eine Nachricht mit numerischen IDs
|
||||
# in `recipient` mit HTTP 200 quittiert und sie an einen *anderen*
|
||||
# Benutzer zugestellt — sie meldet einen falschen Empfaenger also nicht
|
||||
# zwingend als Fehler. Deshalb nach jedem Versand nachsehen, wer die
|
||||
# Konversation tatsaechlich bekommen hat. Loeschen laesst sie sich nicht
|
||||
# (`DELETE /mail/<id>` gibt es nicht), nur Teilnehmer entfernen.
|
||||
teilnehmer = mail_teilnehmer(session, conv_id)
|
||||
if not teilnehmer:
|
||||
print("ACHTUNG: Teilnehmerliste nicht lesbar — Zustellung nicht geprüft.")
|
||||
return
|
||||
print("Teilnehmer laut Server:")
|
||||
for u in teilnehmer:
|
||||
print(f" {u.get('display_name')} ({u.get('guid')})")
|
||||
drin = {str(u.get("guid")) for u in teilnehmer}
|
||||
ich = eigene_guid(session)
|
||||
fehlend = [g for g in guids if g not in drin]
|
||||
fremd = [u for u in teilnehmer
|
||||
if str(u.get("guid")) not in guids and str(u.get("guid")) != ich]
|
||||
if fehlend:
|
||||
print("ACHTUNG: nicht zugestellt an " +
|
||||
", ".join(f"{namen[g]} ({g})" for g in fehlend))
|
||||
if fremd:
|
||||
print("ACHTUNG: unerwartete Teilnehmer — entfernen mit:")
|
||||
for u in fremd:
|
||||
print(f" ./humhub.py mail-user-remove {conv_id} {u.get('id')}")
|
||||
|
||||
|
||||
def cmd_mail_user_remove(args: argparse.Namespace) -> None:
|
||||
"""Nimmt einen Teilnehmer aus einer Konversation.
|
||||
|
||||
Der einzige Weg, eine Fehlzustellung zurueckzunehmen: die Konversation
|
||||
selbst laesst sich weder ueber die API noch ueber die Oberflaeche
|
||||
loeschen. Anders als beim Versand will diese Route die **numerische ID**,
|
||||
nicht die GUID.
|
||||
"""
|
||||
session, _ = get_session()
|
||||
user = resolve_user_info(session, args.user)
|
||||
uid = user.get("id")
|
||||
r = session.delete(f"{BASE_URL}/mail/{args.id}/user/{uid}")
|
||||
if not r.ok:
|
||||
sys.exit(f"Error {r.status_code}: {r.text[:200]}")
|
||||
print(f"{user.get('display_name')} (ID {uid}) aus Konversation "
|
||||
f"{args.id} entfernt. Verbleibend:")
|
||||
for u in mail_teilnehmer(session, args.id):
|
||||
print(f" {u.get('display_name')} ({u.get('guid')})")
|
||||
|
||||
|
||||
def cmd_mail_reply(args: argparse.Namespace) -> None:
|
||||
@@ -588,8 +681,17 @@ def main() -> None:
|
||||
p.add_argument("to", help="Benutzername, Profil-URL oder ID; mehrere mit Komma")
|
||||
p.add_argument("title", help="Betreff")
|
||||
p.add_argument("file", help="Markdown-Datei oder '-' für stdin")
|
||||
p.add_argument("--send", action="store_true",
|
||||
help="wirklich senden (ohne: Probelauf mit Empfängernamen)")
|
||||
p.set_defaults(func=cmd_mail_send)
|
||||
|
||||
# mail-user-remove
|
||||
p = sub.add_parser("mail-user-remove",
|
||||
help="Teilnehmer aus einer Konversation entfernen (Fehlzustellung)")
|
||||
p.add_argument("id", type=int, help="Konversations-ID")
|
||||
p.add_argument("user", help="Benutzername, Profil-URL oder ID")
|
||||
p.set_defaults(func=cmd_mail_user_remove)
|
||||
|
||||
# mail-reply
|
||||
p = sub.add_parser("mail-reply", help="In einer bestehenden Konversation antworten")
|
||||
p.add_argument("id", type=int, help="Konversations-ID (aus /mail/mail/index?id=NN)")
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
name: mediawiki
|
||||
description: MediaWiki-Seiten und -Templates lesen, rendern und schreiben. Use when editing/fetching wiki pages (wiki.inmedias.it, devwiki.inmedias.it) or when the user mentions "wiki", "Vorlage/Template", "Kundenseite".
|
||||
version: 0.1.0
|
||||
description: MediaWiki-Seiten und -Templates lesen, rendern, schreiben und deren Parser-Cache leeren. Use when editing/fetching wiki pages (wiki.inmedias.it, devwiki.inmedias.it) or when the user mentions "wiki", "Vorlage/Template", "Kundenseite", or when a page shows stale API data.
|
||||
version: 0.2.0
|
||||
---
|
||||
|
||||
# MediaWiki (wiki.py)
|
||||
@@ -37,6 +37,8 @@ oder anderen direkten Server-Eingriffen. Reine Lese-/Render-Checks
|
||||
./wiki.py -w devwiki search "Suchbegriff" [-n <namespace>] # Titelsuche
|
||||
./wiki.py -w devwiki update "Kunde:Beispiel GmbH" datei.wiki --summary "..." # speichern
|
||||
./wiki.py -w wiki update "Titel" - --summary "..." # Inhalt von stdin
|
||||
./wiki.py -w wiki purge "Titel" ["Titel 2" ...] [--links] # Parser-Cache leeren
|
||||
./wiki.py -w wiki upload /pfad/bild.png bild.png --description "..." # Datei hochladen
|
||||
```
|
||||
|
||||
Tipp: Beim Schreiben den Inhalt aus einer Datei (`datei.wiki`) oder `-` (stdin)
|
||||
@@ -57,6 +59,27 @@ dann `.env` im aktuellen Verzeichnis, dann bereits gesetzte Env-Variablen). Sieh
|
||||
|
||||
Es empfiehlt sich ein eigener Bot-/Service-Account mit den nötigen Schreibrechten.
|
||||
|
||||
## Seiten, die ihre Daten aus einer API holen
|
||||
|
||||
Vorlagen mit `#get_web_data` (External Data) werden **nicht** bei jedem
|
||||
Seitenaufruf ausgeführt. MediaWiki liefert die Seite aus dem Parser-Cache und
|
||||
fragt die API gar nicht erst an. Ändern sich die Daten hinter der API, zeigt
|
||||
die Seite weiter beliebig alte Werte — ohne Fehlermeldung, ohne dass es
|
||||
jemandem auffällt.
|
||||
|
||||
Deshalb gehört nach jedem Datenupload ein Purge:
|
||||
|
||||
```bash
|
||||
./wiki.py -w wiki purge "Nextcloud (Hosting)"
|
||||
```
|
||||
|
||||
`--links` schaltet zusätzlich `forcelinkupdate` ein (langsamer, aktualisiert
|
||||
die Linktabellen) — für reine Datenaktualisierungen nicht nötig.
|
||||
|
||||
Das betrifft auch die Fehlersuche: Wer nach einer Änderung `render` aufruft und
|
||||
die alten Werte sieht, hat meist nicht die Daten kaputt, sondern nur den Cache
|
||||
vor sich. Erst purgen, dann urteilen.
|
||||
|
||||
## Hinweise
|
||||
- `search` liefert Titel; `render` ist nützlich, um vor/nach dem Schreiben das
|
||||
Ergebnis zu prüfen, ohne die Seite im Browser zu öffnen.
|
||||
|
||||
@@ -110,6 +110,25 @@ def cmd_render(args: argparse.Namespace) -> None:
|
||||
print(result["parse"]["text"]["*"], end="")
|
||||
|
||||
|
||||
def cmd_purge(args: argparse.Namespace) -> None:
|
||||
"""Parser-Cache einer oder mehrerer Seiten leeren.
|
||||
|
||||
Noetig fuer Seiten, die ihre Daten per #get_web_data aus einer API holen:
|
||||
MediaWiki rendert sonst aus dem Parser-Cache weiter und fragt die API gar
|
||||
nicht erst an - die Seite zeigt dann beliebig alte Werte, ohne dass das
|
||||
irgendwo auffaellt.
|
||||
"""
|
||||
site = get_site(args.wiki)
|
||||
result = site.api("purge", titles="|".join(args.titles),
|
||||
forcelinkupdate=1 if args.links else None)
|
||||
for entry in result.get("purge", []):
|
||||
title = entry.get("title", "?")
|
||||
if "missing" in entry:
|
||||
print(f"Error: page '{title}' does not exist", file=sys.stderr)
|
||||
else:
|
||||
print(f"Purged '{title}'")
|
||||
|
||||
|
||||
def cmd_upload(args: argparse.Namespace) -> None:
|
||||
path = Path(args.file_path)
|
||||
if not path.exists():
|
||||
@@ -161,6 +180,12 @@ def main() -> None:
|
||||
render_p.add_argument("title", help="Page title")
|
||||
render_p.set_defaults(func=cmd_render)
|
||||
|
||||
purge_p = sub.add_parser("purge", help="Clear the parser cache of one or more pages")
|
||||
purge_p.add_argument("titles", nargs="+", help="Page title(s)")
|
||||
purge_p.add_argument("--links", action="store_true",
|
||||
help="Also run forcelinkupdate (slower, updates link tables)")
|
||||
purge_p.set_defaults(func=cmd_purge)
|
||||
|
||||
upload_p = sub.add_parser("upload", help="Upload a local file to the wiki file store")
|
||||
upload_p.add_argument("file_path", help="Absolute path to the local file")
|
||||
upload_p.add_argument("wiki_filename", help="Target filename on the wiki (without 'File:' prefix)")
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "redmine",
|
||||
"version": "0.1.0",
|
||||
"description": "Redmine via REST-API: Projekte/Tickets auflisten, anlegen, aktualisieren, kommentieren (redmine.py).",
|
||||
"version": "0.2.0",
|
||||
"description": "Redmine via REST-API: Projekte/Tickets/Versionen/News auflisten, anlegen, aktualisieren, kommentieren (redmine.py).",
|
||||
"author": {
|
||||
"name": "inmedias.it"
|
||||
}
|
||||
|
||||
@@ -1,15 +1,16 @@
|
||||
---
|
||||
name: redmine
|
||||
description: Redmine-Projekte und -Tickets lesen/anlegen/aktualisieren/kommentieren via REST-API. Use when the user mentions "Redmine", "Ticket", "Issue in Redmine", "Meilenstein/Milestone" or das Projekt "pg-wissen".
|
||||
version: 0.1.0
|
||||
description: Redmine-Projekte, -Tickets, -Versionen und -News lesen/anlegen/aktualisieren via REST-API. Use when the user mentions "Redmine", "Ticket", "Issue in Redmine", "Meilenstein/Milestone/Version", "Projektstand/News" or die Projekte "pg-wissen"/"devops".
|
||||
version: 0.2.0
|
||||
---
|
||||
|
||||
# Redmine (redmine.py)
|
||||
|
||||
Interagiert mit Redmine (https://redmine.inmedias.it) über die REST-API:
|
||||
Projekte und Tickets auflisten, anzeigen, anlegen, aktualisieren und
|
||||
kommentieren — über die mitgelieferte, self-contained `redmine.py`. Namen
|
||||
werden auf IDs aufgelöst (Projekt, Tracker, Status, Priorität).
|
||||
Projekte, Tickets, Versionen und News auflisten, anzeigen, anlegen,
|
||||
aktualisieren und kommentieren - über die mitgelieferte, self-contained
|
||||
`redmine.py`. Namen werden auf IDs aufgelöst (Projekt, Tracker, Status,
|
||||
Priorität, Version).
|
||||
|
||||
## Ausführen
|
||||
|
||||
@@ -43,9 +44,10 @@ werden auf IDs aufgelöst (Projekt, Tracker, Status, Priorität).
|
||||
### Anlegen / Aktualisieren / Kommentieren
|
||||
|
||||
`--project` und `--subject` sind bei `create` Pflicht. Beschreibung inline
|
||||
(`--description`) oder aus Datei/stdin (`--description-file -`) übergeben — nicht
|
||||
(`--description`) oder aus Datei/stdin (`--description-file -`) übergeben - nicht
|
||||
als langes Shell-Argument (Sonderzeichen). Weitere Felder: `--tracker`,
|
||||
`--status`, `--priority`, `--assigned me`, `--parent <id>`, `--done <0-100>`.
|
||||
`--status`, `--priority`, `--assigned me`, `--parent <id>`, `--version <name|id>`,
|
||||
`--done <0-100>`.
|
||||
|
||||
```bash
|
||||
./redmine.py create --project pg-wissen --subject "Titel" \
|
||||
@@ -54,6 +56,44 @@ als langes Shell-Argument (Sonderzeichen). Weitere Felder: `--tracker`,
|
||||
./redmine.py comment 290 "kurzer Kommentar"
|
||||
```
|
||||
|
||||
### Versionen (Meilensteine)
|
||||
|
||||
Versionen tragen die grobe Reihenfolge und speisen die Roadmap-Ansicht.
|
||||
|
||||
```bash
|
||||
./redmine.py versions --project devops # auflisten
|
||||
./redmine.py versions --project devops --name "Phase 1" \
|
||||
--due 2026-10-15 --description "Was in dieser Phase zu tun ist"
|
||||
./redmine.py create --project devops --subject "Schritt" --version "Phase 1"
|
||||
./redmine.py update 350 --version 23 # ohne --project: ID
|
||||
```
|
||||
|
||||
Ein Versionsname lässt sich nur mit `--project` auflösen, weil Versionen zu
|
||||
einem Projekt gehören. Bei `update` ist `--project` meist nicht angegeben -
|
||||
dort die Versions-ID verwenden.
|
||||
|
||||
Anlegen erfordert das Recht *manage_versions*.
|
||||
|
||||
### News (Projektstand, Ankündigungen)
|
||||
|
||||
```bash
|
||||
./redmine.py news --project devops # auflisten
|
||||
./redmine.py news --project devops --title "Kurzer Titel" \
|
||||
--summary "Eine Zeile für die Übersicht" \
|
||||
--description-file text.md
|
||||
./redmine.py news --id 1 --description-file korrigiert.md # ändern
|
||||
```
|
||||
|
||||
Zwei Eigenheiten der Redmine-API:
|
||||
|
||||
- **Der Titel darf höchstens 60 Zeichen haben**, sonst HTTP 422. `redmine.py`
|
||||
prüft das vorab.
|
||||
- Die Antwort beim Anlegen enthält **keine News-ID**; der Befehl gibt deshalb
|
||||
die Projekt-URL aus statt eines toten Direktlinks. Ändern per `--id` geht
|
||||
trotzdem (`PUT /news/{id}.json`).
|
||||
|
||||
Format ist Markdown, wie bei Tickets.
|
||||
|
||||
## Zugangsdaten
|
||||
|
||||
`redmine.py` bringt **keinen** Schlüssel mit. Jede/r hinterlegt einen eigenen
|
||||
@@ -71,6 +111,9 @@ gesetzte Env-Variablen). Siehe `.env.example`:
|
||||
|
||||
- Schreibzugriff nur in Projekten mit „Add/Edit issues"-Recht; ein Nicht-Admin
|
||||
kann keine Tickets in fremden Projekten ändern.
|
||||
- Ein neues Milestone (Version) anzulegen erfordert das Recht *manage_versions*
|
||||
und ist über `redmine.py` nicht abgedeckt — dafür die Weboberfläche oder die
|
||||
REST-API (`POST /projects/<id>/versions.json`) nutzen.
|
||||
- **Ticket-Beziehungen** (`blocks`, `relates`, `precedes`) deckt `redmine.py`
|
||||
nicht ab - dafür `POST /issues/<id>/relations.json`. Ein Ticket kann nicht mit
|
||||
einem eigenen Unterticket verknüpft werden (HTTP 422).
|
||||
- Die Priorität eines Elterntickets leitet Redmine aus den Unteraufgaben ab;
|
||||
ein von Hand gesetzter Wert wird überschrieben. Abschaltbar unter
|
||||
Administration → Konfiguration → „Attribute übergeordneter Tickets".
|
||||
@@ -19,6 +19,12 @@ Beispiele:
|
||||
uv run redmine.py update 42 --status Erledigt --notes "gefixt"
|
||||
uv run redmine.py comment 42 "kurzer Kommentar"
|
||||
uv run redmine.py meta trackers
|
||||
uv run redmine.py versions --project devops
|
||||
uv run redmine.py versions --project devops --name "Phase 1" --due 2026-10-15
|
||||
uv run redmine.py create --project devops --subject "Titel" --version "Phase 1"
|
||||
uv run redmine.py news --project devops
|
||||
uv run redmine.py news --project devops --title "Kurz" --description-file text.md
|
||||
uv run redmine.py news --id 1 --description-file korrigiert.md
|
||||
"""
|
||||
|
||||
import argparse
|
||||
@@ -162,6 +168,45 @@ def cmd_show(s, a):
|
||||
+ "\n".join(" " + ln for ln in j["notes"].splitlines()))
|
||||
|
||||
|
||||
def resolve_version(s, project, wert: str) -> int:
|
||||
"""Version über Name oder ID auflösen.
|
||||
|
||||
Ein Name lässt sich nur mit `--project` auflösen, weil Versionen zu einem
|
||||
Projekt gehören. Beim Ändern eines Tickets ist `--project` aber meist
|
||||
nicht angegeben - dort ist die Versions-ID anzugeben.
|
||||
"""
|
||||
if str(wert).isdigit():
|
||||
return int(wert)
|
||||
if not project:
|
||||
sys.exit("--version mit Namen braucht --project (oder gib die Versions-ID an)")
|
||||
pid = resolve_project(s, project)
|
||||
for v in api(s, "GET", f"/projects/{pid}/versions.json").get("versions", []):
|
||||
if v["name"].lower() == str(wert).lower():
|
||||
return v["id"]
|
||||
sys.exit(f"Version '{wert}' nicht in Projekt {pid} gefunden")
|
||||
|
||||
|
||||
def cmd_versions(s, a):
|
||||
"""Versionen eines Projekts auflisten oder anlegen."""
|
||||
pid = resolve_project(s, a.project)
|
||||
if a.name:
|
||||
f = {"name": a.name}
|
||||
if a.due:
|
||||
f["due_date"] = a.due
|
||||
if a.description:
|
||||
f["description"] = a.description
|
||||
v = api(s, "POST", f"/projects/{pid}/versions.json",
|
||||
data=json.dumps({"version": f}))["version"]
|
||||
return print(f"Angelegt: Version #{v['id']} {v['name']}")
|
||||
items = api(s, "GET", f"/projects/{pid}/versions.json").get("versions", [])
|
||||
if a.json:
|
||||
return print(json.dumps(items, ensure_ascii=False, indent=2))
|
||||
if not items:
|
||||
return print("— keine Versionen")
|
||||
for v in items:
|
||||
print(f"#{v['id']:>4} {v['status']:<8} {v.get('due_date') or '—':<12} {v['name']}")
|
||||
|
||||
|
||||
def build_issue_fields(s, a) -> dict:
|
||||
f = {}
|
||||
if getattr(a, "project", None):
|
||||
@@ -182,6 +227,8 @@ def build_issue_fields(s, a) -> dict:
|
||||
f["assigned_to_id"] = resolve_assigned(s, a.assigned)
|
||||
if getattr(a, "parent", None):
|
||||
f["parent_issue_id"] = int(a.parent)
|
||||
if getattr(a, "version", None):
|
||||
f["fixed_version_id"] = resolve_version(s, getattr(a, "project", None), a.version)
|
||||
if getattr(a, "done", None) is not None:
|
||||
f["done_ratio"] = int(a.done)
|
||||
if getattr(a, "notes", None):
|
||||
@@ -211,6 +258,65 @@ def cmd_comment(s, a):
|
||||
print(f"Kommentar an #{a.id} hinzugefügt.")
|
||||
|
||||
|
||||
def cmd_news(s, a):
|
||||
"""News lesen, anlegen oder ändern.
|
||||
|
||||
Drei Betriebsarten, unterschieden an den Angaben:
|
||||
ohne --id, ohne --title auflisten
|
||||
--title anlegen (--project ist Pflicht)
|
||||
--id ändern (PUT, antwortet mit 204)
|
||||
|
||||
Der Titel darf höchstens 60 Zeichen haben; darüber antwortet Redmine
|
||||
mit HTTP 422. Geprüft wird das hier schon vorab, damit der Fehler beim
|
||||
Aufruf steht und nicht im Serverprotokoll.
|
||||
"""
|
||||
if getattr(a, "id", None):
|
||||
fields = {}
|
||||
if a.title:
|
||||
fields["title"] = a.title
|
||||
if a.summary is not None:
|
||||
fields["summary"] = a.summary
|
||||
body = read_text(a.description, a.description_file)
|
||||
if body is not None:
|
||||
fields["description"] = body
|
||||
if not fields:
|
||||
sys.exit("news: nichts zu ändern angegeben")
|
||||
if len(fields.get("title", "")) > 60:
|
||||
sys.exit("news: Titel darf höchstens 60 Zeichen haben")
|
||||
api(s, "PUT", f"/news/{a.id}.json", data=json.dumps({"news": fields}))
|
||||
return print(f"Geändert: News #{a.id} ({', '.join(fields)}) -> {s.base}/news/{a.id}")
|
||||
|
||||
if a.title is None:
|
||||
pid = resolve_project(s, a.project) if a.project else None
|
||||
path = f"/projects/{pid}/news.json" if pid else "/news.json"
|
||||
items = api(s, "GET", path, params={"limit": a.limit}).get("news", [])
|
||||
if a.json:
|
||||
return print(json.dumps(items, ensure_ascii=False, indent=2))
|
||||
if not items:
|
||||
return print("— keine News")
|
||||
for n in items:
|
||||
print(f"#{n['id']:>4} {n.get('created_on', '')[:10]} {n['title']}")
|
||||
return
|
||||
|
||||
if not a.project:
|
||||
sys.exit("news: zum Anlegen ist --project Pflicht")
|
||||
if len(a.title) > 60:
|
||||
sys.exit("news: Titel darf höchstens 60 Zeichen haben")
|
||||
body = read_text(a.description, a.description_file)
|
||||
if body is None:
|
||||
sys.exit("news: --description oder --description-file angeben")
|
||||
pid = resolve_project(s, a.project)
|
||||
fields = {"title": a.title, "description": body}
|
||||
if a.summary:
|
||||
fields["summary"] = a.summary
|
||||
res = api(s, "POST", f"/projects/{pid}/news.json", data=json.dumps({"news": fields}))
|
||||
n = res.get("news", {})
|
||||
if n.get("id"):
|
||||
print(f"Angelegt: News #{n['id']} {n.get('title', '')} -> {s.base}/news/{n['id']}")
|
||||
else:
|
||||
print(f"Angelegt in Projekt {pid} -> {s.base}/projects/{pid}/news")
|
||||
|
||||
|
||||
def cmd_meta(s, a):
|
||||
spec = {
|
||||
"trackers": ("/trackers.json", "trackers"),
|
||||
@@ -258,6 +364,7 @@ def main():
|
||||
c.add_argument("--priority", help="Priorität (Name oder ID)")
|
||||
c.add_argument("--assigned", help="me | User-ID")
|
||||
c.add_argument("--parent", help="übergeordnetes Ticket (ID)")
|
||||
c.add_argument("--version", help="Zielversion (Name oder ID)")
|
||||
c.add_argument("--done", type=int, help="Fortschritt in %% (0-100)")
|
||||
if name == "update":
|
||||
c.add_argument("--notes", help="Kommentar zur Änderung")
|
||||
@@ -265,6 +372,21 @@ def main():
|
||||
pc = sub.add_parser("comment", help="Kommentar an ein Ticket hängen")
|
||||
pc.add_argument("id"); pc.add_argument("text")
|
||||
|
||||
pn = sub.add_parser("news", help="News lesen, anlegen oder ändern")
|
||||
pn.add_argument("--project", help="Projekt (ID/Identifier/Name); zum Anlegen Pflicht")
|
||||
pn.add_argument("--id", help="News-ID - gesetzt heißt: ändern")
|
||||
pn.add_argument("--title", help="Titel (max. 60 Zeichen); gesetzt heißt: anlegen statt auflisten")
|
||||
pn.add_argument("--summary", help="Kurzfassung (optional, erscheint in der Übersicht)")
|
||||
pn.add_argument("--description", help="Text")
|
||||
pn.add_argument("--description-file", help="Datei oder '-' für stdin")
|
||||
pn.add_argument("--limit", type=int, default=25)
|
||||
|
||||
pv = sub.add_parser("versions", help="Versionen auflisten oder anlegen")
|
||||
pv.add_argument("--project", required=True, help="Projekt (ID/Identifier/Name)")
|
||||
pv.add_argument("--name", help="Name - gesetzt heißt: anlegen statt auflisten")
|
||||
pv.add_argument("--due", help="Fälligkeitsdatum (YYYY-MM-DD)")
|
||||
pv.add_argument("--description", help="Beschreibung")
|
||||
|
||||
pm = sub.add_parser("meta", help="Stammdaten auflisten")
|
||||
pm.add_argument("kind", choices=["trackers", "statuses", "priorities"])
|
||||
|
||||
@@ -272,7 +394,8 @@ def main():
|
||||
s, _ = session()
|
||||
{
|
||||
"me": cmd_me, "projects": cmd_projects, "issues": cmd_issues, "show": cmd_show,
|
||||
"create": cmd_create, "update": cmd_update, "comment": cmd_comment, "meta": cmd_meta,
|
||||
"create": cmd_create, "update": cmd_update, "comment": cmd_comment,
|
||||
"news": cmd_news, "versions": cmd_versions, "meta": cmd_meta,
|
||||
}[a.cmd](s, a)
|
||||
|
||||
|
||||
|
||||
Reference in new issue
Block a user