You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-6Lines changed: 12 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,6 @@ This project allows the [Community Tech bot](https://en.wikipedia.org/wiki/User:
16
16
* Page count by namespace
17
17
* Most edited articles last month
18
18
* PRODed articles with deletion logs
19
-
* Editors eligible for autopatrol privileges
20
19
* Active editors with the longest-established accounts
21
20
22
21
## Installation
@@ -29,10 +28,17 @@ Virtualenv is recommended:
29
28
After installation, either activate virtualenv like above or use `venv/bin/python` to run scripts.
30
29
31
30
## Generating a report
32
-
* Log into the Toolforge bastion using your Wikimedia developer account ```ssh username@login.tools.wmflabs.org```
33
-
* Become your tool account ```become database-reports```
34
-
* Run ```python3 main.py test articles_by_size```. It takes two arguments; in this example test refers to `test.wikipedia.org` and `articles_by_size` is the type of statistics you're requesting. This command outputs the name of the page on which the report got dumped
35
-
* To alter the default settings for periodic updates, make changes to the crontab file ```crontab -e```
31
+
32
+
Run ```python3 main.py test orphaned_talk```. It takes two arguments; in this example test refers to
33
+
`test.wikipedia.org` and `orphaned_talk` is the type of statistics you're requesting. This command outputs
34
+
the name of the page on which the report got dumped.
35
+
36
+
You can pass the ```--dry-run``` flag to print output to stdout rather than editing the wiki.
37
+
38
+
On Toolforge, the reports are defined in the ```jobs.yaml``` file.
39
+
See the [Toolforge jobs framework documentation](https://wikitech.wikimedia.org/wiki/Help:Toolforge/Jobs_framework) for more information.
40
+
41
+
If you need to run a one-off job on Toolforge, find the corresponding command in ```jobs.yaml``` and [schedule it](https://wikitech.wikimedia.org/wiki/Help:Toolforge/Jobs_framework#Creating_one-off_jobs) using ```toolforge-jobs```.
36
42
37
43
## Adding support for a report
38
44
* To add support for a specific statistics that you would like to see in a report, declare a function in `main.py` and define it in `reports.py`
@@ -42,4 +48,4 @@ After installation, either activate virtualenv like above or use `venv/bin/pytho
42
48
Bug reports, fixes, and new features are welcomed. If you'd like to contribute code please:
43
49
* Fork the project
44
50
* Start a branch named for your new feature or bug
0 commit comments