Skip to content

docs(readme): install a source checkout with pip - #234

Open
Cherith1222 wants to merge 1 commit into
arviz-devs:mainfrom
Cherith1222:docs/readme-pip-install
Open

Cherith1222 wants to merge 1 commit into
arviz-devs:mainfrom
Cherith1222:docs/readme-pip-install

Conversation

@Cherith1222

Copy link
Copy Markdown

Why

The source-checkout example runs python setup.py install, but this repository has no setup.py. It builds with flit. Fixes #233.

What changed

  • The clone example now runs python -m pip install ..
  • The sentence above that example says pip, not setuptools.

Scope

  • Covers the README source-checkout example.
  • Leaves the pip install git+https://... example as it is.

Blast Radius

Someone following the README to install from a clone now uses pip. The package metadata and the installable code are unchanged.

Verification

  • On main, python setup.py install exits 2 because Python cannot open setup.py.
  • In a fresh virtual environment, python -m pip install . installs arviz-base 1.4.0.dev0. import arviz_base prints 1.4.0.dev0. pip check reports no broken requirements.

Drafted with Cursor.

The documented clone path runs setup.py, and this repository has no setup.py.
@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 arviz-base | 🛠️ Build #35222466 | 📁 Comparing f486bc0 against latest (b87afe3)

  🔍 Preview build  

2 files changed
± api/generated/arviz_base.dict_to_dataset.html
± api/generated/arviz_base.extract.html

This branch has not been deployed

No deployments
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.

README source-checkout installation invokes a nonexistent setup.py

1 participant