feat: add generated CONTRIBUTORS.txt, fixes #47

.pre-commit-config.yaml

@@ -13,3 +13,11 @@ repos:
         exclude: "data/"
       - id: check-merge-conflict
       - id: fix-byte-order-marker
+
+  - repo: local
+    hooks:
+      - id: update-contributors-txt
+        name: Update CONTRIBUTORS.txt
+        language: python
+        entry: python3 etc/scripts/update_contributors_txt.py
+        pass_filenames: false

CONTRIBUTORS.txt

@@ -0,0 +1,14 @@
+Thanks goes to these wonderful people:
+
+Tamás Nepusz (@ntamas)
+Szabolcs Horvát (@szhorvat)
+Jérôme Benoit (@jgmbenoit)
+Robert Schütz (@dotlambda)
+Biswapriyo Nath (@Biswa96)
+Michael Orlitzky (@orlitzky)
+
+This project follows the [all-contributors][1] specification. Contributions of any kind welcome!
+
+This file is an automatically generated, plain-text version of CONTRIBUTORS.md.
+
+[1]: https://github.com/all-contributors/all-contributors

etc/scripts/update_contributors_txt.py

@@ -0,0 +1,41 @@
+#!/usr/bin/env python3
+"""Update the contents of CONTRIBUTORS.txt based on .all-contributorsrc."""
+
+from json import load
+from os import chdir
+from pathlib import Path
+
+
+HEADER = """\
+Thanks goes to these wonderful people:
+
+"""
+
+FOOTER = """\
+
+This project follows the [all-contributors][1] specification. Contributions of any kind welcome!
+
+This file is an automatically generated, plain-text version of CONTRIBUTORS.md.
+
+[1]: https://github.com/all-contributors/all-contributors
+"""
+
+def main():
+    root_dir = Path(__file__).parent.parent.parent
+    chdir(root_dir)
+
+    with (root_dir / ".all-contributorsrc").open("r") as fp:
+        contributors = load(fp)["contributors"]
+
+    with (root_dir / "CONTRIBUTORS.txt").open("w") as fp:
+        fp.write(HEADER)
+        for c in contributors:
+            if c["name"]:
+                fp.write(f"{c['name']} (@{c['login']})\n")
+            else:
+                fp.write(f"@{c['login']}\n")
+        fp.write(FOOTER)
+
+
+if __name__ == "__main__":
+    main()