eris/make-readme.py
Andrew Hamilton d83bea2ba8 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

61 lines
1.5 KiB
Python
Executable file

#!/usr/bin/env python3.9
# -*- coding: utf-8 -*-
import eris.tools as tools
def main():
all_tools = ([(["*"], tools.generic_tools() +
[tools.git_diff, tools.git_blame, tools.git_log])] +
tools.TOOLS_FOR_EXTENSIONS)
tool_set = set()
extension_set = set()
for extensions, tools_ in all_tools:
tool_set.update(tools_)
extension_set.update(extensions)
print(f"""\
# 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-dependencies
# python3.9 -m pip install .
# eris -h
### Docker
# git clone https://github.com/ahamilton/eris
# cd eris
# sudo docker build -t eris .
# cp 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({len(extension_set)-1}) | Tools({len(tool_set)})
----------:| -----""")
for extensions, tools_ in all_tools:
print("%s | %s" % (
" ".join("." + extension for extension in extensions),
"".join(f"[{tool.__name__}]({tool.url})" for tool in tools_)))
if __name__ == "__main__":
main()