Skip to content

docs: complete the arcticpy install recipe - #26

Merged
Jammy2211 merged 1 commit into
mainfrom
feature/arcticpy-install-standardisation
Aug 24, 2026
Merged

docs: complete the arcticpy install recipe#26
Jammy2211 merged 1 commit into
mainfrom
feature/arcticpy-install-standardisation

Conversation

@Jammy2211

Copy link
Copy Markdown
Collaborator

Part of PyAutoLabs/PyAutoHeart#170. Docs-only leg.

AGENTS.md §arcticpy said "install it after numpy" and gave only the bare pip install arcticpy line. That is not enough to install arcticpy on a clean modern venv.

The gaps, each reproduced against a clean build of arcticpy 2.6

  • setuptools/wheel--no-build-isolation does not read arcticpy's build-system.requires, so build deps must already be present. Without setuptools: BackendUnavailable: Cannot import 'setuptools.build_meta'. Python 3.12+ venvs no longer ship setuptools by default.
  • cython — named nowhere in this file, though the build needs it.
  • scipy/matplotlib--no-deps suppresses arcticpy's runtime dependencies, but arcticpy/__init__.py imports read_noise, which imports both at import time, so a successful build still fails at import arcticpy.
  • Verification — arcticpy exposes no __version__ attribute, so arcticpy.__version__ raises AttributeError on a healthy install. Corrected to importlib.metadata.

The section now says why the two flags make the recipe fiddly, rather than only listing commands.

No CI change

This repo has no .github/ directory — it is a docs-only consumer of the recipe. It keeps pointing at PyAutoCTI/AGENTS.md §arcticpy for the full note (including the no-root header workaround, fixed in PyAutoLabs/PyAutoCTI#109), and now also names PyAutoHeart/.github/actions/install-arcticpy as the recipe's single owner and the home of the arcticpy==2.6 pin.


Generated by Claude Code

The recipe said "install it after numpy" and gave only the bare
`pip install arcticpy` line. That is not enough to install arcticpy on a clean
modern venv — three gaps, each reproduced against a clean build of 2.6:

- setuptools/wheel — --no-build-isolation does not read arcticpy's
  build-system.requires, so build deps must already be present. Without
  setuptools: `BackendUnavailable: Cannot import 'setuptools.build_meta'`.
  Python 3.12+ venvs no longer ship setuptools by default.
- cython — named nowhere in this file, though the build needs it.
- scipy/matplotlib — --no-deps suppresses arcticpy's runtime dependencies, but
  arcticpy/__init__.py imports read_noise, which imports both at import time, so
  a successful build still fails at `import arcticpy`.

Also corrects the verification: arcticpy exposes no __version__ attribute, so
`arcticpy.__version__` raises AttributeError on a healthy install.

Points at PyAutoHeart/.github/actions/install-arcticpy as the recipe's single
owner and the home of the arcticpy==2.6 pin.

Refs PyAutoLabs/PyAutoHeart#170

Co-Authored-By: Claude Opus 5 <[email protected]>
Claude-Session: https://claude.ai/code/session_018nDAxBEavkzb6Zkz1cYHef
@Jammy2211
Jammy2211 merged commit 6859873 into main Aug 24, 2026
@Jammy2211
Jammy2211 deleted the feature/arcticpy-install-standardisation branch August 25, 2026 18:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants