Merge branch 'thh-parsedb' into pu
[usenet/newsstats.git] / doc / README
... / ...
CommitLineData
1NewsStats 0.1 (c) 2010-2013 Thomas Hochstein <thh@inter.net>
2
3NewsStats is a software package for gathering statistical data live
4from a Usenet feed and subsequent examination.
5
6This script package is free software; you can redistribute it and/or
7modify it under the terms of the GNU Public License as published by
8the Free Software Foundation.
9
10---------------------------------------------------------------------
11
12What's that?
13
14 There's a multitude of tools for the statistical examination of
15 newsgroups: number of postings per month or per person, longest
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
23Workflow
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
30 statistical aspect, e.g. number of postings per group and month.
31
32 Several kinds of reports can then be generated from those result
33 tables.
34
35Prerequisites
36
37 NewsStats is written in Perl (5.8.x and above) and makes use of a
38 MySQL database, so you will need Perl, some modules, mysql and, of
39 course, INN.
40
41 * Perl 5.8.x with standard modules
42 - Cwd
43 - File::Basename
44 - Sys::Syslog
45
46 * Perl modules form CPAN
47 - Config::Auto
48 - Date::Format
49 - DBI
50 - Mail::Address
51
52 * mysql 5.0.x
53
54 * working installation of INN
55
56Installation instructions
57
58 See INSTALL.
59
60Getting Started
61
62 'feedlog.pl' will continuously feed raw data to your raw data
63 table. See the feedlog.pl man page for more information.
64
65 You can process that data via 'gatherstats.pl'; currently only the
66 tabulation of postings per group and month is supported. More to
67 come. See the gatherstats.pl man page for more information.
68
69 Report generation is handled by specialised scripts for each
70 report type. Currently only reports on the number of postings per
71 group and month are supported; you can use 'groupstats.pl' for
72 this. See the groupstats.pl man page for more information.
73
74Reporting Bugs
75
76 You can report bugs or feature requests to the author using the
77 bug tracker at <http://bugs.th-h.de/>.
78
79 Please have a look at the TODO list before suggesting
80 improvements.
81
82More Information
83
84 This program is maintained using the Git version control system.
85 You may clone <git://code.th-h.de/usenet/newsstats.git> to check
86 out the current development tree or browse it on the web via
87 <http://code.th-h.de/?p=usenet/newsstats.git>.
88
89Related projects
90
91 <http://usenet.dex.de/> is a site were data gathered via NewsStats
92 is used for a graphical presentation of activity in the de.*
93 Usenet hierarchy over the years (since 1992).
94
95Author
96
97 Thomas Hochstein <thh@inter.net>
98 <http://th-h.de/>
99
This page took 0.00981 seconds and 4 git commands to generate.