forgejo_admin
Repositories
58
 Projects Packages
18
 Public activity Starred repositories

pal-e-docs-sdk (0.1.0)

Published 2026-03-07 23:55:58 +00:00 by forgejo_admin

Installation

pip install --index-url  pal-e-docs-sdk

About this package

Python SDK for the pal-e-docs REST API

pal-e-docs-sdk

Python SDK for the pal-e-docs REST API via httpx.

Install

pip install pal-e-docs-sdk --index-url https://forgejo.tail5b443a.ts.net/api/packages/forgejo_admin/pypi/simple/

Usage

from pal_e_docs_sdk import PalEDocsClient

client = PalEDocsClient(base_url="https://pal-e-docs.tail5b443a.ts.net")

# Typed endpoint methods
notes = client.list_notes(tags="sop,active")
note = client.get_note("my-note-slug")
results = client.search_notes("database migration")
tags = client.list_tags()
projects = client.list_projects()
links = client.get_note_links("my-note-slug")
repos = client.list_repos(status="active")

# Low-level HTTP helpers still available
raw = client.get("/some/custom/path", params={"key": "value"})

Endpoint Coverage

Domain Method SDK Method HTTP
Notes list_notes() NotesMixin GET /notes
get_note(slug) NotesMixin GET /notes/{slug}
create_note(...) NotesMixin POST /notes
update_note(slug, ...) NotesMixin PUT /notes/{slug}
delete_note(slug) NotesMixin DELETE /notes/{slug}
get_note_revisions(slug) NotesMixin GET /notes/{slug}/revisions
Search search_notes(q, ...) SearchMixin GET /notes/search
Tags list_tags() TagsMixin GET /tags
Projects list_projects() ProjectsMixin GET /projects
create_project(...) ProjectsMixin POST /projects
Links get_note_links(slug) LinksMixin GET /notes/{slug}/links
update_note_links(slug, ...) LinksMixin PUT /notes/{slug}/links
Repos list_repos(...) ReposMixin GET /repos
create_repo(...) ReposMixin POST /repos
update_repo(slug, ...) ReposMixin PUT /repos/{slug}

15 endpoints across 6 mixins. Sprints and blocks endpoints planned for Phase 8c/8d.

Development

pip install -e ".[dev]"
pytest tests/ -v
ruff check src/ tests/

Requirements

Requires Python: >=3.12
Details
PyPI
2026-03-07 23:55:58 +00:00
15
MIT
26 KiB
Assets (2)
pal_e_docs_sdk-0.1.0-py3-none-any.whl 11 KiB
pal_e_docs_sdk-0.1.0.tar.gz 15 KiB
Versions (4) View all
0.4.0 2026-03-14
0.3.0 2026-03-14
0.2.0 2026-03-08
0.1.0 2026-03-07