eris/packaging/make-readme.py

68 lines
1.8 KiB
Python
Executable file

#!/usr/bin/env python3.9
# -*- coding: utf-8 -*-
import eris.tools as tools
def main():
git_tools = [tools.git_diff, tools.git_blame, tools.git_log]
all_tools = [(["*"], tools.generic_tools() + git_tools)] + 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
# eris -h
# eris-webserver <project>
### 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
### Snap
# Download snap file from github releases page:
https://github.com/ahamilton/eris/releases
# snap install --dangerous eris_2021.12.06_amd64.snap
# eris -h
# eris.webserver <project>
# rm eris_2021.12.06_amd64.snap # The snap file is no longer needed.
### AppImage
# Download AppImage file from github releases page:
https://github.com/ahamilton/eris/releases
# chmod +x eris_2021.12.06.AppImage
# mv eris_2021.12.06.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()