initial 2 minute version
[python-rwhoisd.git] / README
1 WHAT IS IT?
2
3 As a programming exercise for learning Python, I wrote a simple rwhois
4 server.  It uses in-memory data structures, and it intuits
5 the schema based on the data it sees.  The server as input takes a
6 schema file, which for now just describes which attributes should be
7 indexed (and how), and data files which look much like the C rwhoisd's
8 data files.
9
10 REQUIREMENTS
11
12 python 2.2 or later
13
14 INSTALL
15
16 For now, just run it from the source directory:
17
18
19 RUNNING IT
20
21 % tar zxvf python-rwhoisd-0.1.tar.gz
22
23 % cd python-rwhoisd-0.1
24
25 % ./bin/pyrwhoisd sample_data/example_schema \
26                   sample_data/example_data &
27
28 Voila!  You should now have some sort of rwhois server running on port
29 4321
30
31 CONFIGURING IT
32
33 Edit rwhoisd/config.py.
34 This file is sort of commented as to what you can change.
35
36
37 DATA
38
39 See the example_schema and example_data files in the sample_data
40 directory.