Skip to content

Commit acfc153

Browse files
committed
More stuff for README
1 parent 02a1e0a commit acfc153

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,32 @@
1-
# database-reports
2-
Generating specific reports from the English Wikipedia
1+
# Database Reports
2+
Generates statistical reports which are used by community members to improve Wikipedia.
3+
4+
This project allows the [Community Tech bot](https://en.wikipedia.org/wiki/User:Community_Tech_bot) to make periodic updates to these reports on different language Wikipedias. As of now the project support report generation for English ([see here](https://en.wikipedia.org/wiki/Wikipedia:Database_reports)), Vietnamese, Korean and French Wikipedia.
5+
6+
## Specific statistics that the reports support:
7+
* Unused templates
8+
* Forgotten articles
9+
* Most used templates
10+
* New wiki projects
11+
* Talk pages by size
12+
* Orphaned talk pages
13+
* Unused file redirects
14+
* Forgotten articles
15+
* Page with most revisions
16+
* Page count by namespace
17+
* Most edited articles last month
18+
* PRODed articles with deletion logs
19+
* Editors eligible for autopatrol privileges
20+
* Active editors with the longest-established accounts
21+
22+
## Usage
23+
* Log into the Toolforge bastion using your Wikimedia developer account ```ssh username@login.tools.wmflabs.org```
24+
* Become your tool account ```become database-reports```
25+
* Run ```python 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
26+
* To alter the default settings for periodic updates, make changes to the crontab file ```crontab -e```
27+
28+
## Contributing
29+
Bug reports, fixes, and new features are welcomed. If you'd like to contribute code please:
30+
* Fork the project
31+
* Start a branch named for your new feature or bug
32+
* Create a pull request

0 commit comments

Comments
 (0)