diff --git a/README.md b/README.md index f966da3..874dbbf 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,28 @@ ## Summary -Eris maintains an up-to-date set of reports for every file in a codebase. +Eris maintains an up to date set of reports for every file in a codebase. ## Installation #### Debian / Ubuntu / Fedora / Arch / Alpine -Install eris with pipx, then install all the tools eris uses: +Firstly uv is needed to install eris. - pipx install --system-site-packages git+https://gitlab.com/ahamilton/eris@v2025.06.04#subdirectory=eris +To install uv: + + curl -LsSf https://astral.sh/uv/install.sh | sh + +For other ways to install uv see its [installation page](https://docs.astral.sh/uv/getting-started/installation/). + +Then use uv to install eris: + + uv tool install git+https://gitlab.com/ahamilton/eris@v2025.06.04 + +Then use eris to install all the tools it uses: eris --install-all-tools -Or install from source: (includes tools) +Or install from source: (including tools) git clone https://gitlab.com/ahamilton/eris cd eris @@ -26,10 +36,10 @@ Then to run: ## Tools -File types(100) | Tools(57) +File types(100) | Tools(56) ----------:| ----- .* | [contents](http://pygments.org/) • [metadata](https://github.com/ahamilton/eris) • [git_diff](https://git-scm.com/docs/git-diff) • [git_blame](https://git-scm.com/docs/git-blame) • [git_log](https://git-scm.com/docs/git-log) -.py | [python_syntax](https://en.wikipedia.org/wiki/Python_syntax_and_semantics) • [python_unittests](https://docs.python.org/3/library/unittest.html) • [pytest](https://docs.pytest.org/en/latest/) • [pydoc](https://docs.python.org/3/library/pydoc.html) • [mypy](http://mypy-lang.org/) • [python_coverage](https://coverage.readthedocs.io/) • [pycodestyle](http://pycodestyle.pycqa.org/en/latest/) • [pydocstyle](http://www.pydocstyle.org/en/2.1.1/usage.html) • [pyflakes](https://pypi.org/project/pyflakes/) • [pylint](https://www.pylint.org/) • [python_gut](https://github.com/ahamilton/eris) • [python_mccabe](https://pypi.org/project/mccabe/) • [bandit](https://pypi.org/project/bandit/) +.py | [python_syntax](https://en.wikipedia.org/wiki/Python_syntax_and_semantics) • [python_unittests](https://docs.python.org/3/library/unittest.html) • [pytest](https://docs.pytest.org/en/latest/) • [pydoc](https://docs.python.org/3/library/pydoc.html) • [mypy](http://mypy-lang.org/) • [python_coverage](https://coverage.readthedocs.io/) • [pycodestyle](http://pycodestyle.pycqa.org/en/latest/) • [pyflakes](https://pypi.org/project/pyflakes/) • [pylint](https://www.pylint.org/) • [python_gut](https://github.com/ahamilton/eris) • [python_mccabe](https://pypi.org/project/mccabe/) • [bandit](https://pypi.org/project/bandit/) .pl .pm .t | [perl_syntax](https://en.wikipedia.org/wiki/Perl) • [perldoc](http://perldoc.perl.org/) .p6 .pm6 | [perl6_syntax](https://rakudo.org/) .pod .pod6 | [perldoc](http://perldoc.perl.org/) diff --git a/install b/install index e4081a7..74554c6 100755 --- a/install +++ b/install @@ -5,5 +5,5 @@ set -e set -x -pipx install --system-site-packages "$@" . +uv tool install "$@" . eris --install-all-tools diff --git a/packaging/make-readme.py b/packaging/make-readme.py index fae28d8..1f10441 100755 --- a/packaging/make-readme.py +++ b/packaging/make-readme.py @@ -18,18 +18,28 @@ def main(): ## Summary -Eris maintains an up-to-date set of reports for every file in a codebase. +Eris maintains an up to date set of reports for every file in a codebase. ## Installation #### Debian / Ubuntu / Fedora / Arch / Alpine -Install eris with pipx, then install all the tools eris uses: +Firstly uv is needed to install eris. - pipx install --system-site-packages git+https://gitlab.com/ahamilton/eris@v2025.06.04#subdirectory=eris +To install uv: + + curl -LsSf https://astral.sh/uv/install.sh | sh + +For other ways to install uv see its [installation page](https://docs.astral.sh/uv/getting-started/installation/). + +Then use uv to install eris: + + uv tool install git+https://gitlab.com/ahamilton/eris@v2025.06.04 + +Then use eris to install all the tools it uses: eris --install-all-tools -Or install from source: (includes tools) +Or install from source: (including tools) git clone https://gitlab.com/ahamilton/eris cd eris