~darkmoon/+junk/darkstat-pkg

« back to all changes in this revision

Viewing changes to python/README

  • Committer: Bazaar Package Importer
  • Author(s): Cédric Delfosse
  • Date: 2004-06-11 23:18:07 UTC
  • Revision ID: james.westby@ubuntu.com-20040611231807-n6inlmb4cs4yyi84
Tags: upstream-2.6
Import upstream version 2.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
                             Python darkstat API
 
3
 
 
4
WHAT IS IT
 
5
   This is a collection of packages and scripts to access darkstat API from
 
6
Python.
 
7
   The "darkstat" subdirectory contains the main API package. The file
 
8
setup.py is Python Distutils setup script. Run "python setup.py --help" to
 
9
get help. The file total-bytes.py is just an example script that show how
 
10
to use darkstat API.
 
11
   The file dstat-wait.py is a real script that uses the API; it
 
12
periodically asks darkstat about total number of bytes passed and waits
 
13
until the number gets increased by a given amount, then stop. It can be
 
14
used, for example, in a script like that:
 
15
 
 
16
# /etc/rc.d/firewall open
 
17
# /usr/local/sbin/dstat-wait.py localhost 8080 10M
 
18
# /etc/rc.d/firewall close
 
19
 
 
20
 
 
21
WHERE TO GET
 
22
   http://purl.org/net/darkstat
 
23
 
 
24
 
 
25
HOW TO INSTALL
 
26
   There is a simple Makefile for those who prefer to run "make install".
 
27
The real work is done by Python Distutils. You can run
 
28
"python setup.py install" by yourself.
 
29
 
 
30
 
 
31
AUTHOR
 
32
   Oleg Broytmann <phd@phd.pp.ru>
 
33
 
 
34
LICENSE
 
35
   GPL