OpenParable
Skip to content
← Back to skills

Python Client API

Development
python-client-api

Python Client API is an Agent Skill for development published in the fossasia/visdom repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Add or modify Visdom Python client methods with correct server/frontend parity and typing updates

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/fossasia/visdom/blob/HEAD/.agents/skills/python-client-api/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/python-client-api, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Skill: Python Client API Changes

When to Use

Use this skill when adding or changing methods in py/visdom/__init__.py.

Core Workflow

  1. Add/update the Visdom method in py/visdom/__init__.py.
  2. Keep @pytorch_wrap on public plotting APIs.
  3. Build payloads through self._send(...) with consistent keys (data, win, eid, opts).
  4. Update py/visdom/__init__.pyi for type stub parity.
  5. If payload shape changes, update server handling (py/visdom/utils/server_utils.py) and pane rendering assumptions.
  6. Add or update demo usage in example/ and relevant Cypress tests.

Guardrails

  • Do not bypass _send() with ad-hoc transport logic.
  • Keep backward compatibility for win, env, and update behavior.
  • API changes must be reflected in docs and type stubs.

Documentation

  • Skill reference
  • py/visdom/__init__.py
  • py/visdom/__init__.pyi
  • py/visdom/utils/server_utils.py
  • py/visdom/server/handlers/web_handlers.py
  • AGENTS.md
  • CONTRIBUTING.md

Assets

  • See assets/README.md and store templates/resources in assets/.

Tests

  • Follow the default flow in references/TESTS.md.