xor-freenet / pyfreenet Goto Github PK

README file for pyFreenet

fcpVersion = "0.2.5"


PyFreenet is a suite of command-line freenet applications, as well as a
powerful Python library, for freenet 0.7.

This pyFreenet release includes:

 - command-line freenet client applications, which will get installed as
   executable commands in your PATH, including:

     - freesitemgr - a simple yet flexible freesite management utility
     - fcpnames - utility for managing the new 'name service' layer
     - fproxyproxy - an experimental http proxy that sits on top of
       fproxy, and translates human-friendly site names transparently
     - fcpget - a single key fetcher
     - fcpput - a single key inserter
     - fcpgenkey - a keypair generator
     - fcpinvertkey - generate new SSK/USK keypairs
     - fcpredirect - insert a redirect from one 'key' to another 'key'.

 - an XML-RPC server for freenet access, which can be run standalone, or
   easily integrated into an existing website

 - python package 'fcp', containing classes for interacting with freenet.

To get good API documentation, run:

    $ epydoc -n "pyFreenet API manual" -o html fcp

When you install this package (refer INSTALL), you should 
end up with a command 'freesitemgr' on your PATH.

'freesitemgr' is a console-based freesite insertion utility
which keeps your freesite configs and status in a single
config file (~/.freesitemgr, unless you specify otherwise).

Invoke 'freesitemgr -h' (or if on windows, 'freesitemgr.py -h')
and read the options.