Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Update authors script

Roland Geiderd17699668b9d
diff --git a/extras/authors/README.md b/extras/authors/README.md
index 789f76615..35e9c5960 100644
--- a/extras/authors/README.md
+++ b/extras/authors/README.md
@@ -1,13 +1,18 @@
# Generate authors list
This small script reads the commit information and generates a list of authors
-and links them to their Github profile, if available. This can be run before
+and links them to their GitHub profile, if available. This can be run before
each release to keep the data up to date.
## Usage
-Generate a token to avoid the rate limiting on the Github API:
+Note that you might run into rate-limiting issues if you run this script too
+often. If so, you can generate a token and use it in the script:
<https://github.com/settings/personal-access-tokens> (no need to select any
permissions, we're just performing reading operations on public data)
Run the script and optionally copy the generated files to their correct locations
+
+```bash
+uv run generate_authors_api.py
+```
diff --git a/extras/authors/generate_authors_api.py b/extras/authors/generate_authors_api.py
index f1c6ce02d..ba63b40df 100644
--- a/extras/authors/generate_authors_api.py
+++ b/extras/authors/generate_authors_api.py
@@ -9,6 +9,12 @@ from pathlib import Path
# Third Party
import requests
+# /// script
+# dependencies = [
+# "requests",
+# ]
+# ///
+
ORGANIZATION = 'wger-project'
REPOSITORIES = ['wger', 'flutter', 'react', 'docker', 'docs']
COMMITS_PER_PAGE = 100