Commit | Line | Data |
---|---|---|
07c0b258 | 1 | NewsStats 0.1 (c) 2010-2013 Thomas Hochstein <thh@inter.net> |
610b5ef4 TH |
2 | |
3 | NewsStats is a software package for gathering statistical data live | |
4 | from a Usenet feed and subsequent examination. | |
5 | ||
6 | This script package is free software; you can redistribute it and/or | |
7 | modify it under the terms of the GNU Public License as published by | |
8 | the Free Software Foundation. | |
9 | ||
10 | --------------------------------------------------------------------- | |
11 | ||
12 | What's that? | |
13 | ||
14 | There's a multitude of tools for the statistical examination of | |
6e6c520f | 15 | newsgroups: number of postings per month or per person, longest |
610b5ef4 TH |
16 | threads, and so on (see <http://th-h.de/infos/usenet/stats.php> |
17 | [German language] for an incomplete list). Most of them use a per- | |
18 | newsgroup approach while NewsStats is hierarchy oriented. | |
19 | ||
20 | NewsStats will accumulate data from a live INN feed, allowing you | |
21 | to process the saved information later on. | |
22 | ||
23 | Workflow | |
24 | ||
25 | NewsStats saves overview data and complete headers of (all) | |
26 | incoming postings to a (MySQL) database in real time. | |
27 | ||
28 | That raw data will be regularly - e.g. monthly - processed to a | |
29 | second set of database tables each dedicated to a certain | |
6e6c520f | 30 | statistical aspect, e.g. number of postings per group and month. |
610b5ef4 TH |
31 | |
32 | Several kinds of reports can then be generated from those result | |
33 | tables. | |
34 | ||
35 | Prerequisites | |
36 | ||
37 | NewsStats is written in Perl (5.8.x and above) and makes use of a | |
6e6c520f DW |
38 | MySQL database, so you will need Perl, some modules, mysql and, of |
39 | course, INN. | |
610b5ef4 TH |
40 | |
41 | * Perl 5.8.x with standard modules | |
42 | - Cwd | |
43 | - File::Basename | |
44 | - Sys::Syslog | |
45 | ||
46 | * Perl modules form CPAN | |
53dcbea6 | 47 | - Config::Auto |
610b5ef4 TH |
48 | - Date::Format |
49 | - DBI | |
50 | ||
51 | * mysql 5.0.x | |
52 | ||
53 | * working installation of INN | |
54 | ||
55 | Installation instructions | |
56 | ||
57 | See INSTALL. | |
58 | ||
59 | Getting Started | |
60 | ||
61 | 'feedlog.pl' will continuously feed raw data to your raw data | |
62 | table. See the feedlog.pl man page for more information. | |
63 | ||
64 | You can process that data via 'gatherstats.pl'; currently only the | |
6e6c520f | 65 | tabulation of postings per group and month is supported. More to |
610b5ef4 TH |
66 | come. See the gatherstats.pl man page for more information. |
67 | ||
68 | Report generation is handled by specialised scripts for each | |
69 | report type. Currently only reports on the number of postings per | |
6e6c520f | 70 | group and month are supported; you can use 'groupstats.pl' for |
53dcbea6 | 71 | this. See the groupstats.pl man page for more information. |
610b5ef4 TH |
72 | |
73 | Reporting Bugs | |
74 | ||
53dcbea6 | 75 | You can report bugs or feature requests to the author using the |
610b5ef4 TH |
76 | bug tracker at <http://bugs.th-h.de/>. |
77 | ||
147194c1 TH |
78 | Please have a look at the TODO list before suggesting |
79 | improvements. | |
80 | ||
610b5ef4 TH |
81 | More Information |
82 | ||
83 | This program is maintained using the Git version control system. | |
84 | You may clone <git://code.th-h.de/usenet/newsstats.git> to check | |
85 | out the current development tree or browse it on the web via | |
86 | <http://code.th-h.de/?p=usenet/newsstats.git>. | |
87 | ||
88 | Related projects | |
89 | ||
90 | <http://usenet.dex.de/> is a site were data gathered via NewsStats | |
91 | is used for a graphical presentation of activity in the de.* | |
53dcbea6 | 92 | Usenet hierarchy over the years (since 1992). |
610b5ef4 TH |
93 | |
94 | Author | |
95 | ||
96 | Thomas Hochstein <thh@inter.net> | |
97 | <http://th-h.de/> | |
6e6c520f | 98 |