eris/packaging/make-readme.py
Andrew Hamilton fd4357c513 packaging: Update README with move to Gitlab
- github -> gitlab
- Not providing snaps or appimages on gitlab yet since it seems
  gitlab doesn't allow arbitrary files to be put on release pages.
  (They also weren't migrated in the import)
- Also have moved from ubuntu to debian.
2023-09-11 00:22:05 +10:00

61 lines
1.6 KiB
Python
Executable file

#!/usr/bin/env python3.11
# -*- 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
#### Debian 12 (Bookworm)
Install eris directly using pipx, and apt install the tools eris relies on:
sudo apt install pipx
pipx install --system-site-packages git+https://gitlab.com/ahamilton/eris@v2022.12.06#subdirectory=eris
eris --apt-install-tools
Or install from source: (including tools)
git clone https://gitlab.com/ahamilton/eris
cd eris
./install
Then to run:
eris -h
eris-webserver <project> # Or a simple web interface.
#### Docker
git clone https://gitlab.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
## 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()