scientific-python / repo-review

Framework that can run checks on repos
https://repo-review.readthedocs.io
BSD 3-Clause "New" or "Revised" License
66 stars 3 forks source link

docs: describe install methods #148

Closed mwtoews closed 1 year ago

mwtoews commented 1 year ago

This is possibly a transient issue, but trying to install on py310 or py312 in a venv on linux yields the same error:

$ pipx run sp-repo-review .
Traceback (most recent call last):
  File "<string>", line 1, in <module>
  File "/home/mtoews/.local/pipx/.cache/036cea750998512/lib/python3.12/site-packages/repo_review/__main__.py", line 11, in <module>
    import click as orig_click
ModuleNotFoundError: No module named 'click'
$ pip install click
Requirement already satisfied: click in /tmp/py312/lib/python3.12/site-packages (8.1.7)
henryiii commented 1 year ago

You need to install or run repo-review[cli].

In WebAssembly, you don’t need/want click. Also, pipx always uses a clean, isolated environment. If you want it locally in a venv you can use pip.

mwtoews commented 1 year ago

Should the docs describe how to install for CLI? It's sort-of there, but it perhaps needs to be more direct.

This seems to work:

pip install repo-review[cli] sp-repo-review
henryiii commented 1 year ago

Yes, they should.