eris/README.md

# Eris Codebase Monitor

## Summary

Eris maintains an up-to-date set of reports for every file in a codebase.

## Installation

### Ubuntu (21.10)

    # git clone https://github.com/ahamilton/eris
    # cd eris
    # ./install
    # eris -h

### Docker

    # git clone https://github.com/ahamilton/eris
    # cd eris
    # sudo docker build -t eris -f packaging/Dockerfile .
    # cp packaging/eris-docker ~/bin/eris    # e.g. Put wrapper script in your PATH
    # eris -h

### AppImage

    # Download AppImage file from github releases page:
      https://github.com/ahamilton/eris/releases
    # chmod +x eris-2020-09-24.AppImage
    # mv eris-2020-09-24.AppImage ~/bin/eris    # e.g. Put appimage in your PATH
    # eris -h

## Tools

File types(100) | Tools(60)
----------:| -----
.* | [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_modulefinder](https://docs.python.org/3/library/modulefinder.html) • [dis](https://docs.python.org/3/library/dis.html) • [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/)
.c .h | [c_syntax_gcc](https://gcc.gnu.org/) • [cppcheck](http://sourceforge.net/p/cppcheck/wiki/Home/)
.cc .cpp .hpp | [cpp_syntax_gcc](https://gcc.gnu.org/) • [cppcheck](http://sourceforge.net/p/cppcheck/wiki/Home/)
.rb | [ruby_syntax](http://www.ruby-lang.org/)
.lua | [lua_syntax](http://www.lua.org) • [lua_check](https://github.com/mpeterv/luacheck)
.js | [js_syntax](http://nodejs.org/)
.php | [php8_syntax](https://en.wikipedia.org/wiki/PHP)
.go | [go_vet](https://github.com/golang/go) • [godoc](https://github.com/golang/go)
.bash .sh .dash .ksh | [shellcheck](https://www.shellcheck.net/)
.wasm | [wasm_validate](https://github.com/WebAssembly/wabt) • [wasm_objdump](https://github.com/WebAssembly/wabt)
.pdf | [pdf2txt](https://github.com/pdfminer/pdfminer.six)
.html .htm | [html_syntax](https://www.html-tidy.org/) • [html2text](http://www.mbayer.de/html2text/) • [elinks](http://elinks.cz/)
.yaml .yml | [yamllint](https://github.com/adrienverge/yamllint)
.md .epub .docx .odt .rst | [pandoc](https://pandoc.org/)
.zip .jar .apk .egg .whl | [zipinfo](http://www.info-zip.org/UnZip.html)
.tar.gz .tgz | [tar_gz](http://www.gnu.org/software/tar/manual/tar.html)
.tar.bz2 | [tar_bz2](http://www.gnu.org/software/tar/manual/tar.html)
.rar | [unrar](http://www.rarlabs.com/)
.7z | [7z](http://p7zip.sourceforge.net/)
.xz | [unxz](https://tukaani.org/xz/)
.a | [ar](https://en.wikipedia.org/wiki/Ar_(Unix)) • [nm](https://linux.die.net/man/1/nm)
.o | [objdump_headers](https://en.wikipedia.org/wiki/Objdump) • [objdump_disassemble](https://en.wikipedia.org/wiki/Objdump) • [readelf](https://en.wikipedia.org/wiki/Objdump)
.so | [nm](https://linux.die.net/man/1/nm)
.deb | [dpkg_contents](https://wiki.debian.org/Teams/Dpkg) • [dpkg_info](https://wiki.debian.org/Teams/Dpkg)
.rpm | [rpm](http://rpm.org/)
.png .jpg .gif .bmp .tif .tiff .tga .ico .xpm | [mediainfo](https://mediaarea.net/MediaInfo) • [pil](http://python-pillow.github.io/)
.svg .svgz | [cairosvg](https://cairosvg.org/)
.mkv .mka .mks .ogg .ogm .avi .wav .mpeg .mpg .vob .mp4 .mpgv .mpv .m1v .m2v .mp2 .mp3 .asf .wma .wmv .qt .mov .rm .rmvb .ra .ifo .ac3 .dts .aac .flac .aiff .aifc .au .iff .flv .srt .ssa .ass .sami | [mediainfo](https://mediaarea.net/MediaInfo)
.iso | [isoinfo](https://manpages.debian.org/jessie/genisoimage/isoinfo.1.en.html)
Improved the project title. 2018-09-25 10:41:55 +10:00			`# Eris Codebase Monitor`
Add the project summary to the README. 2016-09-30 16:21:29 +02:00
docker: Add installation instructions. 2020-01-10 14:04:57 +10:00			`## Summary`
Add the project summary to the README. 2016-09-30 16:21:29 +02:00
Rename the project to Eris. 2018-09-17 23:59:38 +10:00			`Eris maintains an up-to-date set of reports for every file in a codebase.`
Make the script easy to run 2015-12-26 20:52:39 +00:00
docker: Add installation instructions. 2020-01-10 14:04:57 +10:00			`## Installation`
Make the script easy to run 2015-12-26 20:52:39 +00:00
release: Move eris to ubuntu 21.10. - Update readme. - php7 -> php8. - Fix python-coverage. - Also need python decorator module. - Replaced Mcrt1 with rotatingtree since Mcrt1 started raising a new warning. 2021-10-18 01:40:39 +10:00			`### Ubuntu (21.10)`
Make the script easy to run 2015-12-26 20:52:39 +00:00
Rename the project to Eris. 2018-09-17 23:59:38 +10:00			`# git clone https://github.com/ahamilton/eris`
			`# cd eris`
Create an install script. 2021-10-31 22:49:13 +10:00			`# ./install`
Simplify ubuntu installation instructions. 2020-01-11 12:11:45 +10:00			`# eris -h`
Describe installation of vigil on older ubuntus. 2016-09-30 16:50:35 +02:00
docker: Add installation instructions. 2020-01-10 14:04:57 +10:00			`### Docker`

			`# git clone https://github.com/ahamilton/eris`
			`# cd eris`
Move packaging scripts for docker and appimage into subdirectory. - De-clutter the project root directory. 2021-11-03 21:23:15 +10:00			`# sudo docker build -t eris -f packaging/Dockerfile .`
			`# cp packaging/eris-docker ~/bin/eris # e.g. Put wrapper script in your PATH`
appimage: Add installation instructions. 2020-01-10 14:13:30 +10:00			`# eris -h`

			`### AppImage`

			`# Download AppImage file from github releases page:`
			`https://github.com/ahamilton/eris/releases`
release: Update readme file with new versions. 2020-09-24 23:13:41 +10:00			`# chmod +x eris-2020-09-24.AppImage`
			`# mv eris-2020-09-24.AppImage ~/bin/eris # e.g. Put appimage in your PATH`
appimage: Add installation instructions. 2020-01-10 14:13:30 +10:00			`# eris -h`
docker: Add installation instructions. 2020-01-10 14:04:57 +10:00
			`## Tools`
List the tools in the README. 2016-11-19 13:50:07 +01:00
tools: Add git diff. - This is worth it afterall. - Eris will get out of sync when the diffs are commited, but this is also true of git-blame and git-log. - The user can refresh the old results with shift-r. 2021-07-11 16:25:25 +10:00			`File types(100) \| Tools(60)`
Revert "readme: Trying centre alignment in tools table." This reverts commit c6359a8873455da53a2fd68501141e3a106a9a33. 2018-06-05 08:16:49 +10:00			`----------:\| -----`
tools: Add git diff. - This is worth it afterall. - Eris will get out of sync when the diffs are commited, but this is also true of git-blame and git-log. - The user can refresh the old results with shift-r. 2021-07-11 16:25:25 +10:00			`.* \| [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)`
Add a command-line option providing information about tools. - All tools have a url. - Not deriving the url from the package database. 2020-04-11 21:45:41 +10:00			.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_modulefinder](https://docs.python.org/3/library/modulefinder.html) • [dis](https://docs.python.org/3/library/dis.html) • [python_mccabe](https://pypi.org/project/mccabe/) • [bandit](https://pypi.org/project/bandit/)
Remove perltidy temporarily for flatpak build. 2019-05-20 15:16:03 +10:00			`.pl .pm .t \| [perl_syntax](https://en.wikipedia.org/wiki/Perl) • [perldoc](http://perldoc.perl.org/)`
tools: Add rakudo for checking perl6 syntax. 2019-07-10 21:36:40 +10:00			`.p6 .pm6 \| [perl6_syntax](https://rakudo.org/)`
Add more hyperlinks to tool's homepages. 2016-11-19 19:44:00 +01:00			`.pod .pod6 \| [perldoc](http://perldoc.perl.org/)`
Remove code formatters. - Maybe these should be returned if the output is a diff with the current file. - bcpp, uncrustify, gofmt, clang_format. 2019-05-17 11:10:45 +10:00			`.c .h \| [c_syntax_gcc](https://gcc.gnu.org/) • [cppcheck](http://sourceforge.net/p/cppcheck/wiki/Home/)`
			`.cc .cpp .hpp \| [cpp_syntax_gcc](https://gcc.gnu.org/) • [cppcheck](http://sourceforge.net/p/cppcheck/wiki/Home/)`
tools: Added ruby_syntax for ruby files. 2018-06-05 07:06:58 +10:00			`.rb \| [ruby_syntax](http://www.ruby-lang.org/)`
tools: Added syntax and linter checkers for lua files. 2018-06-05 08:55:18 +10:00			`.lua \| [lua_syntax](http://www.lua.org) • [lua_check](https://github.com/mpeterv/luacheck)`
Remove code formatters. - Maybe these should be returned if the output is a diff with the current file. - bcpp, uncrustify, gofmt, clang_format. 2019-05-17 11:10:45 +10:00			`.js \| [js_syntax](http://nodejs.org/)`
release: Move eris to ubuntu 21.10. - Update readme. - php7 -> php8. - Fix python-coverage. - Also need python decorator module. - Replaced Mcrt1 with rotatingtree since Mcrt1 started raising a new warning. 2021-10-18 01:40:39 +10:00			`.php \| [php8_syntax](https://en.wikipedia.org/wiki/PHP)`
tools: Remove golint. - golint has been deprecated. 2021-06-01 01:05:09 +10:00			`.go \| [go_vet](https://github.com/golang/go) • [godoc](https://github.com/golang/go)`
Changes for Ubuntu 18.10. 2018-12-27 14:47:39 +10:00			`.bash .sh .dash .ksh \| [shellcheck](https://www.shellcheck.net/)`
Add missed webassembly changes of readme 2019-07-10 11:54:01 +10:00			`.wasm \| [wasm_validate](https://github.com/WebAssembly/wabt) • [wasm_objdump](https://github.com/WebAssembly/wabt)`
Coding style. - Move some python tools into tools.toml. 2019-01-21 14:06:42 +10:00			`.pdf \| [pdf2txt](https://github.com/pdfminer/pdfminer.six)`
Add a command-line option providing information about tools. - All tools have a url. - Not deriving the url from the package database. 2020-04-11 21:45:41 +10:00			`.html .htm \| [html_syntax](https://www.html-tidy.org/) • [html2text](http://www.mbayer.de/html2text/) • [elinks](http://elinks.cz/)`
readme: Ordered the tools table better. 2018-06-05 21:30:59 +10:00			`.yaml .yml \| [yamllint](https://github.com/adrienverge/yamllint)`
			`.md .epub .docx .odt .rst \| [pandoc](https://pandoc.org/)`
tools: Python wheel files are also zip archives. 2018-06-04 10:59:03 +10:00			`.zip .jar .apk .egg .whl \| [zipinfo](http://www.info-zip.org/UnZip.html)`
Add more hyperlinks to tool's homepages. 2016-11-19 19:44:00 +01:00			`.tar.gz .tgz \| [tar_gz](http://www.gnu.org/software/tar/manual/tar.html)`
			`.tar.bz2 \| [tar_bz2](http://www.gnu.org/software/tar/manual/tar.html)`
tools: Added unrar for rar archive files. 2018-06-04 08:27:34 +10:00			`.rar \| [unrar](http://www.rarlabs.com/)`
tools: Fixed a broken dependency in 7z. - This was missed in the original commit: 6c78f9c0 2018-06-05 09:01:46 +10:00			`.7z \| [7z](http://p7zip.sourceforge.net/)`
tools: Add svglib to view svg files. 2019-06-29 16:06:14 +10:00			`.xz \| [unxz](https://tukaani.org/xz/)`
tools: Added ar for ".a" archive files. 2018-06-04 08:51:07 +10:00			`.a \| [ar](https://en.wikipedia.org/wiki/Ar_(Unix)) • [nm](https://linux.die.net/man/1/nm)`
readme: Ordered the tools table better. 2018-06-05 21:30:59 +10:00			`.o \| [objdump_headers](https://en.wikipedia.org/wiki/Objdump) • [objdump_disassemble](https://en.wikipedia.org/wiki/Objdump) • [readelf](https://en.wikipedia.org/wiki/Objdump)`
tools: Added ar for ".a" archive files. 2018-06-04 08:51:07 +10:00			`.so \| [nm](https://linux.die.net/man/1/nm)`
readme: Ordered the tools table better. 2018-06-05 21:30:59 +10:00			`.deb \| [dpkg_contents](https://wiki.debian.org/Teams/Dpkg) • [dpkg_info](https://wiki.debian.org/Teams/Dpkg)`
			`.rpm \| [rpm](http://rpm.org/)`
tools: pil can also view some xpm files. 2020-05-09 18:55:44 +10:00			`.png .jpg .gif .bmp .tif .tiff .tga .ico .xpm \| [mediainfo](https://mediaarea.net/MediaInfo) • [pil](http://python-pillow.github.io/)`
Use ubuntu dependencies for tools. - No longer sourcing deps for flatpak's sake. - Switching from svglib to cairosvg since svglib not in ubuntu. 2021-11-26 02:10:06 +10:00			`.svg .svgz \| [cairosvg](https://cairosvg.org/)`
tools: Mediainfo also works with subtitle file formats. 2018-06-04 08:30:14 +10:00			`.mkv .mka .mks .ogg .ogm .avi .wav .mpeg .mpg .vob .mp4 .mpgv .mpv .m1v .m2v .mp2 .mp3 .asf .wma .wmv .qt .mov .rm .rmvb .ra .ifo .ac3 .dts .aac .flac .aiff .aifc .au .iff .flv .srt .ssa .ass .sami \| [mediainfo](https://mediaarea.net/MediaInfo)`
tools: Add isoinfo for iso image files. 2018-09-27 19:27:35 +10:00			`.iso \| [isoinfo](https://manpages.debian.org/jessie/genisoimage/isoinfo.1.en.html)`