Skip to content

development.md

Latest commit

 

History

History
47 lines (33 loc) · 1.61 KB

development.md

File metadata and controls

47 lines (33 loc) · 1.61 KB
Raw

Development

Layout

  • src/alphaxiv: package code
  • tests/unit: parser, type, and CLI-context tests
  • tests/integration: mocked HTTP client tests
  • tests/e2e: live smoke tests for the public and authenticated CLI or SDK

Test Commands

uv run pytest
ALPHAXIV_RUN_E2E=1 uv run pytest tests/e2e -q

If you need to work on browser-backed auth:

uv sync --extra browser
uv run playwright install chromium

Live smoke layers:

  • Public smoke: ALPHAXIV_RUN_E2E=1 uv run pytest tests/e2e -q
  • Auth smoke: same command, plus ALPHAXIV_API_KEY in the environment
  • Assistant write smoke: add ALPHAXIV_RUN_ASSISTANT_WRITES=1 The smoke helper prefers browser-backed auth copied from ~/.alphaxiv/browser-profile when it is available, and otherwise falls back to ALPHAXIV_API_KEY.

Public vs Authenticated Scope

This codebase intentionally targets direct HTTP access to alphaXiv's public and authenticated endpoints.

Folders, comment mutations, paper votes, paper views, overview generation, and assistant commands use direct HTTP + SSE where applicable. They can authenticate through either:

  • an alphaXiv API key
  • a browser-backed session saved by alphaxiv auth login-web

This matters because some alphaXiv accounts can read authenticated metadata with an API key but cannot perform certain writes unless the request uses the browser-backed web session. The current browser-backed path saves an alphaXiv session cookie when the web app does not expose a bearer token.

All live smoke tests use a temporary ALPHAXIV_HOME, so they do not read from or write to the operator's real local CLI state.